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":"5c1695df-0be1-48e2-9b01-71f8495a672f","task_status_uuid":"da807649-c9bf-4c19-b622-47521f95dddf","parent_task_uuid":"9113a647-5a02-4648-9a8a-172f8168a2c8","assigned_to_uuids":["93379910-564c-4d8a-838f-5a0a4a98111e","c5b0f1f0-1228-440c-b619-fd1a5a2e692c"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["6098c485-20e6-41ec-9b52-972cdacc65aa","698abada-35a7-4b21-ab51-ffc44aac9c33"]}'
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": "5c1695df-0be1-48e2-9b01-71f8495a672f",
"task_status_uuid": "da807649-c9bf-4c19-b622-47521f95dddf",
"parent_task_uuid": "9113a647-5a02-4648-9a8a-172f8168a2c8",
"assigned_to_uuids": [
"93379910-564c-4d8a-838f-5a0a4a98111e",
"c5b0f1f0-1228-440c-b619-fd1a5a2e692c"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"6098c485-20e6-41ec-9b52-972cdacc65aa",
"698abada-35a7-4b21-ab51-ffc44aac9c33"
]
}
Response examples (200)
{
"name": "Document the transaction",
"uuid": "e0d257d7-5140-4a3c-a2a3-fff4f087b689",
"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": "c3ca0fa6-07cd-493d-a8d4-d0d5650b4840",
"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-04-22T13:44:18+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-04-22T13:44:18+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": "08e9059d-9cc7-4e91-a00f-950197ac6518",
"colour": "#398898",
"position": 1,
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+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": "01336bbf-b186-4565-8011-3dc37ec8e01a",
"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",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"completed_at": "2025-04-22T13:44:18+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "0d32cd85-572b-4193-a0ea-cd06971792ff",
"participants_count": 4
},
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+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": "5fc49c01-af8a-4cd8-b452-4c99f7623da5",
"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-04-22T13:44:18+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-04-22T13:44:18+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": "77aab2b0-1011-4dfd-996a-95ef2f0acd0d",
"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-04-22T13:44:18+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-04-22T13:44:18+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": "f3fb1e9f-6be7-4b2a-a29e-2e7e93852194",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"taskable_type": "case"
}