Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
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":"06f622d4-6c9b-4be2-8f29-88862d667ce3","task_status_uuid":"1b1b604c-48ef-457c-b1e4-71c2e0bf7a09","parent_task_uuid":"1f886d73-d014-425d-9541-adf18a2cd7c4","assigned_to_uuids":["efa000b4-1322-431f-80a9-ca748a4fc1e7","ceefd316-a82d-4eef-9d1a-99c014f207a6"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["f644f5f8-3bb6-41bb-bcb7-371ef1b4e00d","09d4bffe-1595-4202-935b-9f6fbb791b9c"]}'
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": "06f622d4-6c9b-4be2-8f29-88862d667ce3",
"task_status_uuid": "1b1b604c-48ef-457c-b1e4-71c2e0bf7a09",
"parent_task_uuid": "1f886d73-d014-425d-9541-adf18a2cd7c4",
"assigned_to_uuids": [
"efa000b4-1322-431f-80a9-ca748a4fc1e7",
"ceefd316-a82d-4eef-9d1a-99c014f207a6"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"f644f5f8-3bb6-41bb-bcb7-371ef1b4e00d",
"09d4bffe-1595-4202-935b-9f6fbb791b9c"
]
}
Response examples (200)
{
"name": "Document the transaction",
"uuid": "2f4e216a-976c-46eb-b857-63c2a461c611",
"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": "f1b5a425-7815-45de-8d7e-f9084244550b",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "Email"
},
"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-02-20T10:13:03+00: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-02-20T10:13:03+00: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": "765d0d3f-4683-44d3-bc0d-44c216926121",
"colour": "#398898",
"position": 1,
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00: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": "97a883ba-fe27-4686-8a0d-4d904e6bcffc",
"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-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"completed_at": "2025-02-20T10:13:03+00:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "5479711d-ea0a-4de4-a9c9-46dd13cf2eba",
"participants_count": 4
},
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00: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": "5d5593b1-b997-460b-9a79-baf32af56b77",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "Email"
},
"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-02-20T10:13:03+00: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-02-20T10:13:03+00: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": "916537c8-07e5-4153-b825-5220cd7a46c0",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "Email"
},
"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-02-20T10:13:03+00: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-02-20T10:13:03+00: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": "cd1741e8-907d-4828-8a68-da57ce7270f8",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"taskable_type": "case"
}