Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body Required
-
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
-
The taskable type. Available Options: client, case, plan
-
The taskable UUID
-
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 created.
POST
/api/v1/task
curl \
--request POST https://api.plannrcrm.com/api/v1/task \
--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":"61300b29-3bb6-4fec-9df7-f24434f3435b","task_status_uuid":"e67901f2-18ce-4cce-bcb1-2b78c656feb6","parent_task_uuid":"333d046e-cc4d-42bc-8f47-a8351b47a310","assigned_to_uuids":["4b457137-ca93-4f0d-9dc2-71b6dee9764f","f58c2820-7e68-4562-a1f5-e5b27a3b8e7b"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["06abdeee-11f6-428d-b1c8-6f2ec3b06186","40bde9b3-8946-4594-bcf3-992978485fec"]}'
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": "61300b29-3bb6-4fec-9df7-f24434f3435b",
"task_status_uuid": "e67901f2-18ce-4cce-bcb1-2b78c656feb6",
"parent_task_uuid": "333d046e-cc4d-42bc-8f47-a8351b47a310",
"assigned_to_uuids": [
"4b457137-ca93-4f0d-9dc2-71b6dee9764f",
"f58c2820-7e68-4562-a1f5-e5b27a3b8e7b"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"06abdeee-11f6-428d-b1c8-6f2ec3b06186",
"40bde9b3-8946-4594-bcf3-992978485fec"
]
}
Response examples (201)
{
"name": "Document the transaction",
"uuid": "e144c993-3e96-4a1d-8e91-b530f1014e30",
"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": "8925b7df-7970-466c-87f3-17013167a201",
"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": "d0150d90-b365-41a1-8a23-3e4da4b103e0",
"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": "775e52f5-ce61-4380-84d9-74d0eaff49ad",
"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": "a19588b9-4389-4299-b3f9-26547879b990",
"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": "506c34f9-30c3-46c9-abaf-b6c0f42230d5",
"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": "350a5992-1fa0-4bd4-925d-a2c2f4deb7bb",
"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": "baa69a91-b05e-4c5d-b74f-7009a70c4574",
"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"
}