Body
-
The name of the task
-
The description of the task
-
The task's priority. Available options: low, medium, high and highest
-
The task due date
-
The taskable type. Available Options: client, case, plan
-
The taskable UUID
-
The task status UUID
-
The parent task UUID
-
Array of account UUIDs
-
Additional custom fields
-
UUIDs of groups that will be assigned when the task is updated.
PUT
/api/v1/task/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/task/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"Check details","description":"Check details","priority":"low","due_at":"2020-01-01 00:00:00","taskable_type":"plan","taskable_uuid":"7a520a4f-31fc-44dc-b0f1-3b46124dd623","task_status_uuid":"4483ddbe-5e07-43e5-bc6f-27cbda609dc9","parent_task_uuid":"c3a5d7e2-8a60-4f7f-8b85-0ac5be4da23e","assigned_to_uuids":["3c525707-7d4b-4c50-b898-2ffcb1f27712","a0f786f6-9de2-4c64-856c-37d3bdccefd0"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["fc920381-5c24-4811-b481-d9678b1bc329","625122cd-6b53-455a-aad6-313a72eec158"]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Check details",
"description": "Check details",
"priority": "low",
"due_at": "2020-01-01 00:00:00",
"taskable_type": "plan",
"taskable_uuid": "7a520a4f-31fc-44dc-b0f1-3b46124dd623",
"task_status_uuid": "4483ddbe-5e07-43e5-bc6f-27cbda609dc9",
"parent_task_uuid": "c3a5d7e2-8a60-4f7f-8b85-0ac5be4da23e",
"assigned_to_uuids": [
"3c525707-7d4b-4c50-b898-2ffcb1f27712",
"a0f786f6-9de2-4c64-856c-37d3bdccefd0"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"fc920381-5c24-4811-b481-d9678b1bc329",
"625122cd-6b53-455a-aad6-313a72eec158"
]
}
Response examples (200)
{
"name": "Document the transaction",
"uuid": "d75ef2fb-08cd-4a42-9f54-a6e2f0a1fcd2",
"author": {
"name": {
"example": "Gareth Thompson",
"collection": false,
"description": "Name"
},
"role": {
"example": "client",
"collection": false,
"description": "Account role"
},
"type": {
"example": "client",
"collection": false,
"description": "Account type"
},
"uuid": {
"example": "eae3e54e-611f-4d4d-9596-fbba09b7066a",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
},
"last_name": {
"example": "Thompson",
"collection": false,
"description": "Last name"
},
"photo_url": {
"example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"collection": false,
"description": "The photo URL of the client"
},
"created_at": {
"example": "2025-10-08T10:40:15+01:00",
"collection": false,
"description": "The timestamp of when the resource was created."
},
"first_name": {
"example": "Gareth",
"collection": false,
"description": "First name"
},
"updated_at": {
"example": "2025-10-08T10:40:15+01:00",
"collection": false,
"description": "The timestamp of when the resource was updated."
},
"external_references": {
"example": "App\\Http\\Resources\\ExternalReferenceResource",
"collection": true,
"description": "The external references that have been added to the client."
}
},
"due_at": "2021-01-01 00:00:00",
"status": {
"name": "Incomplete",
"uuid": "cc7f2545-a812-440f-8fbe-4963d09686fd",
"colour": "#398898",
"position": 1,
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"is_archived": false,
"is_not_started": false,
"is_type_completed": false
},
"position": 1,
"priority": "high",
"taskable": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "52d15e6f-3c89-42d2-91c5-acc2435a86cf",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": "App\\Http\\Resources\\CasesStatusResource",
"review_at": "2025-10-08T10:40:15+01:00",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"group_uuids": [
"e1c94b3d-db86-4336-885e-6213652ff416"
],
"completed_at": "2025-10-08T10:40:15+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "5db0431d-9b2f-45fb-bcfc-1ad044d29304",
"assigned_to_uuids": [
"110d39a3-03b8-4c58-bc33-da70a0c13375"
],
"participants_count": 4
},
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"assigned_to": {
"name": {
"example": "Gareth Thompson",
"collection": false,
"description": "Name"
},
"role": {
"example": "client",
"collection": false,
"description": "Account role"
},
"type": {
"example": "client",
"collection": false,
"description": "Account type"
},
"uuid": {
"example": "29ebbdce-7932-4385-872c-3cf67a49498b",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
},
"last_name": {
"example": "Thompson",
"collection": false,
"description": "Last name"
},
"photo_url": {
"example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"collection": false,
"description": "The photo URL of the client"
},
"created_at": {
"example": "2025-10-08T10:40:15+01:00",
"collection": false,
"description": "The timestamp of when the resource was created."
},
"first_name": {
"example": "Gareth",
"collection": false,
"description": "First name"
},
"updated_at": {
"example": "2025-10-08T10:40:15+01:00",
"collection": false,
"description": "The timestamp of when the resource was updated."
},
"external_references": {
"example": "App\\Http\\Resources\\ExternalReferenceResource",
"collection": true,
"description": "The external references that have been added to the client."
}
},
"description": "Document the transaction",
"completed_at": "2021-01-01 00:00:00",
"completed_by": {
"name": {
"example": "Gareth Thompson",
"collection": false,
"description": "Name"
},
"role": {
"example": "client",
"collection": false,
"description": "Account role"
},
"type": {
"example": "client",
"collection": false,
"description": "Account type"
},
"uuid": {
"example": "ad088947-c5e4-4496-8402-167efb3a4a46",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
},
"last_name": {
"example": "Thompson",
"collection": false,
"description": "Last name"
},
"photo_url": {
"example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"collection": false,
"description": "The photo URL of the client"
},
"created_at": {
"example": "2025-10-08T10:40:15+01:00",
"collection": false,
"description": "The timestamp of when the resource was created."
},
"first_name": {
"example": "Gareth",
"collection": false,
"description": "First name"
},
"updated_at": {
"example": "2025-10-08T10:40:15+01:00",
"collection": false,
"description": "The timestamp of when the resource was updated."
},
"external_references": {
"example": "App\\Http\\Resources\\ExternalReferenceResource",
"collection": true,
"description": "The external references that have been added to the client."
}
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "fa905a32-f45a-46a4-af88-fc66b123c3da",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"taskable_type": "case"
}