Body
Required
-
The name of the task
-
The description of the task
-
The task's priority. Available options: low, medium, high and highest
-
The task due date
-
The taskable type. Available Options: client, case, plan
-
The taskable UUID
-
The task status UUID
-
The parent task UUID
-
Array of account UUIDs
-
Additional custom fields
-
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 $ACCESS_TOKEN" \
--header "Content-Type: 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":"2885ee00-4127-439b-af97-3ef76f3d33f0","task_status_uuid":"0b91996f-6e9e-47f5-9ba9-3246e712b9d2","parent_task_uuid":"e1e3aa80-11ba-4099-94ea-b59cddd3aecd","assigned_to_uuids":["a341010e-5015-4d2e-b8d2-10fc71395c48","61bba17f-5916-47ac-89e0-acc341feed9c"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["3a74a985-ebcb-4ce4-ad28-48a24c052189","82a57e98-198a-4ee0-97bd-21efaf1a1048"]}'
Request examples
# Headers
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": "2885ee00-4127-439b-af97-3ef76f3d33f0",
"task_status_uuid": "0b91996f-6e9e-47f5-9ba9-3246e712b9d2",
"parent_task_uuid": "e1e3aa80-11ba-4099-94ea-b59cddd3aecd",
"assigned_to_uuids": [
"a341010e-5015-4d2e-b8d2-10fc71395c48",
"61bba17f-5916-47ac-89e0-acc341feed9c"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"3a74a985-ebcb-4ce4-ad28-48a24c052189",
"82a57e98-198a-4ee0-97bd-21efaf1a1048"
]
}
Response examples (201)
{
"name": "Document the transaction",
"uuid": "099fea49-2305-46dc-86b5-a57e38f8b673",
"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": "a83e6d0c-c007-459b-b7f5-0cdf3ece7f78",
"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-08-07T13:41:42+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-08-07T13:41:42+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": "90b63cf5-c1b4-4a18-b43a-f42277d249f2",
"colour": "#398898",
"position": 1,
"created_at": "2025-08-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+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": "6e7296df-256b-42d9-a983-7fae38c4d33f",
"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-08-07T13:41:42+01:00",
"created_at": "2025-08-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+01:00",
"group_uuids": [
"683d71ec-5dea-45b2-92c5-d7537ac62d12"
],
"completed_at": "2025-08-07T13:41:42+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "2c47d8c7-e28d-43a5-9895-0142b7fa3cc6",
"assigned_to_uuids": [
"ab1ce556-c9f3-430e-bf18-44360fbac9e6"
],
"participants_count": 4
},
"created_at": "2025-08-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+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": "1c1490d6-7ebf-4d99-a481-91daad752f44",
"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-08-07T13:41:42+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-08-07T13:41:42+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": "8b258219-5c4f-4857-b6b4-36f85ea099a9",
"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-08-07T13:41:42+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-08-07T13:41:42+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": "001753f5-33eb-49ae-9304-0e27710262bb",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-08-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"taskable_type": "case"
}