Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
integer Required
Body
-
name
string The name of the task
-
description
string The description of the task
-
priority
string The task's priority. Available options: low, medium, high and highest
-
due_at
string The task due date
-
taskable_type
string The taskable type. Available Options: client, case, plan
-
taskable_uuid
string The taskable UUID
-
task_status_uuid
string The task status UUID
-
parent_task_uuid
string The parent task UUID
-
assigned_to_uuids
array[string] Array of account UUIDs
-
custom_fields
array[string] Additional custom fields
-
group_uuids
array[string] 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/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: 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":"95986aa0-506f-46b9-b32a-8493307b3217","task_status_uuid":"6e080cbf-7b62-4160-b650-a518df093ac3","parent_task_uuid":"e627b60c-f509-4925-ba6d-0f1bdf618ee2","assigned_to_uuids":["ad7294b6-8a39-48a3-968c-6edc7ab5aa79","c88765af-1429-4c9e-b8b4-8837d33ac39a"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["5104aa0e-942b-41b5-ad9c-afd7cc779de8","70413218-a72d-4701-aad8-d4fe589e7c72"]}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
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": "95986aa0-506f-46b9-b32a-8493307b3217",
"task_status_uuid": "6e080cbf-7b62-4160-b650-a518df093ac3",
"parent_task_uuid": "e627b60c-f509-4925-ba6d-0f1bdf618ee2",
"assigned_to_uuids": [
"ad7294b6-8a39-48a3-968c-6edc7ab5aa79",
"c88765af-1429-4c9e-b8b4-8837d33ac39a"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"5104aa0e-942b-41b5-ad9c-afd7cc779de8",
"70413218-a72d-4701-aad8-d4fe589e7c72"
]
}
Response examples (200)
{
"name": "Document the transaction",
"uuid": "66526fce-ab63-4cfb-a440-e0c30c65567f",
"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": "0981ed12-63ca-4a19-81fd-cd2a7692b50e",
"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-06-04T16:49:35+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-06-04T16:49:35+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": "95043f50-6324-401b-9f15-ae1ee5e11794",
"colour": "#398898",
"position": 1,
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+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": "ed734717-6532-474d-a229-60ee01f0b119",
"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-06-04T16:49:35+01:00",
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+01:00",
"group_uuids": [
"a8200819-2e3e-4a92-b5b7-874c5404cf27"
],
"completed_at": "2025-06-04T16:49:35+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "1f048b39-65bf-45b2-8483-428b3f95cf4b",
"assigned_to_uuids": [
"fec0a306-9183-4291-b4da-872767aaf10f"
],
"participants_count": 4
},
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+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": "68224f87-df14-4b5b-88cb-77a2973183b9",
"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-06-04T16:49:35+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-06-04T16:49:35+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": "708bcbb8-a480-4000-a2dc-ba04254101ae",
"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-06-04T16:49:35+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-06-04T16:49:35+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": "80babb8f-b87a-4c14-b536-917578ed2a1f",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-04T16:49:35+01:00",
"updated_at": "2025-06-04T16:49:35+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"taskable_type": "case"
}