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":"36a4b5cf-5497-4935-ac99-b8a0284612ba","task_status_uuid":"d193a2f0-1f00-403d-b16a-8cc2a28d5221","parent_task_uuid":"c332b701-7a1e-45a7-a6e1-85cbda5e16a1","assigned_to_uuids":["10019088-81c6-4cb4-a691-3fa8ba6b66fb","958e7c1a-6cb2-46ce-8bc0-0c5be82f45f1"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["109a8ab7-8f82-441b-a046-8a86d296a730","dbca77aa-1fe4-4c45-b208-60c4d1cb230f"]}'
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": "36a4b5cf-5497-4935-ac99-b8a0284612ba",
"task_status_uuid": "d193a2f0-1f00-403d-b16a-8cc2a28d5221",
"parent_task_uuid": "c332b701-7a1e-45a7-a6e1-85cbda5e16a1",
"assigned_to_uuids": [
"10019088-81c6-4cb4-a691-3fa8ba6b66fb",
"958e7c1a-6cb2-46ce-8bc0-0c5be82f45f1"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"109a8ab7-8f82-441b-a046-8a86d296a730",
"dbca77aa-1fe4-4c45-b208-60c4d1cb230f"
]
}
Response examples (200)
{
"name": "Document the transaction",
"uuid": "c8bf6c3b-b30c-47df-8b05-6414b46719e8",
"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": "1fa05589-e703-499c-8049-4fb4051b2b73",
"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-24T10:15:13+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-24T10:15:13+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": "0e0b05ab-6393-44d0-839f-8a2b39798a1b",
"colour": "#398898",
"position": 1,
"created_at": "2025-06-24T10:15:13+01:00",
"updated_at": "2025-06-24T10:15:13+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": "2ca76de6-5a7c-4bd1-a702-e8104e520f91",
"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-24T10:15:13+01:00",
"created_at": "2025-06-24T10:15:13+01:00",
"updated_at": "2025-06-24T10:15:13+01:00",
"group_uuids": [
"b96b3ac7-01d7-4459-9b48-9a7c17df2a38"
],
"completed_at": "2025-06-24T10:15:13+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "87b547a9-6387-4894-babb-d7d7db55a54a",
"assigned_to_uuids": [
"407352b4-1c7c-4d64-98c5-85cd72fe2d48"
],
"participants_count": 4
},
"created_at": "2025-06-24T10:15:13+01:00",
"updated_at": "2025-06-24T10:15:13+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": "f2aee8d0-435f-4648-96ed-2931b5e97b76",
"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-24T10:15:13+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-24T10:15:13+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": "fe5d9c60-5525-460b-88f4-8693bbdf6f2b",
"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-24T10:15:13+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-24T10:15:13+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": "84552aa5-8559-42c5-aad4-8cfaaddac38e",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-24T10:15:13+01:00",
"updated_at": "2025-06-24T10:15:13+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"taskable_type": "case"
}