Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Body
Required
-
name
string 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
-
taskable_type
string Required The taskable type. Available Options: client, case, plan
-
taskable_uuid
string Required The taskable UUID
-
task_status_uuid
string Required 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":"7c33cf98-b1d4-454b-9fa2-29731af08076","task_status_uuid":"e5e6f793-9fba-4881-a044-e7a2086e7117","parent_task_uuid":"f14e38be-555b-40e6-9a31-8b28447c527e","assigned_to_uuids":["06f3b45f-1328-4a6c-9279-d139cb04704b","69e78f62-e4c4-4ad0-b302-50c7b4a4bbd8"],"custom_fields":[{"favourite_pet":"Dog"}],"group_uuids":["8b72b64d-2cfb-49c1-ad64-b65ce19239e4","402956ce-57a5-4029-a762-171235c15067"]}'
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": "7c33cf98-b1d4-454b-9fa2-29731af08076",
"task_status_uuid": "e5e6f793-9fba-4881-a044-e7a2086e7117",
"parent_task_uuid": "f14e38be-555b-40e6-9a31-8b28447c527e",
"assigned_to_uuids": [
"06f3b45f-1328-4a6c-9279-d139cb04704b",
"69e78f62-e4c4-4ad0-b302-50c7b4a4bbd8"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
],
"group_uuids": [
"8b72b64d-2cfb-49c1-ad64-b65ce19239e4",
"402956ce-57a5-4029-a762-171235c15067"
]
}
Response examples (201)
{
"name": "Document the transaction",
"uuid": "2d2578ba-2aab-439f-b83b-f58a67d57613",
"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": "fb3ad368-3b69-4207-9d89-4f6b845ff315",
"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": "fb6f4161-3c9c-4395-9bfd-6b3d0fb5d296",
"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": "980c55cb-a30a-45b0-a0b5-e367dced7454",
"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": "68906972-37c2-440d-bfa3-00a04371324f",
"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": "e3d22b15-091f-42bb-9bf4-d5c032d8f685",
"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": "69e896a2-9f00-43cc-b884-93c8a871a6d5",
"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": "369fce8a-0a64-44c7-963a-84f93dea30d6",
"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"
}