Create a task
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
POST
/api/v1/task
curl \
-X POST https://api.plannrcrm.com/api/v1/task \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
-d '{"name":"Check details","description":"Check details","priority":"low","due_at":"2020-01-01 00:00:00","taskable_type":"plan","taskable_uuid":"9075e3ca-a7c4-4ca3-adae-1b0d0e090779","task_status_uuid":"66a1e5cc-9629-4060-a2b2-a8a1d91e3505","parent_task_uuid":"282ef1d8-c8c2-463b-a1cb-5515d626b97c","assigned_to_uuids":["b2befb6a-91d2-4669-904d-663643b41cf6","0460b34c-6af9-486c-a291-40d68afa5ed4"],"custom_fields":[{"favourite_pet":"Dog"}]}'
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": "9075e3ca-a7c4-4ca3-adae-1b0d0e090779",
"task_status_uuid": "66a1e5cc-9629-4060-a2b2-a8a1d91e3505",
"parent_task_uuid": "282ef1d8-c8c2-463b-a1cb-5515d626b97c",
"assigned_to_uuids": [
"b2befb6a-91d2-4669-904d-663643b41cf6",
"0460b34c-6af9-486c-a291-40d68afa5ed4"
],
"custom_fields": [
{
"favourite_pet": "Dog"
}
]
}
Response examples (201)
{
"name": "Document the transaction",
"uuid": "331f9051-cb8c-47fd-8021-0010034056a6",
"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": "f8e5470d-66d1-4ce9-85bb-8c4d293360e6",
"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-01-12T12:55:58+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-01-12T12:55:58+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": "1be46850-c0f0-4de6-bb6a-c8ed770bf45f",
"colour": "#398898",
"position": 1,
"created_at": "2025-01-12T12:55:58+00:00",
"updated_at": "2025-01-12T12:55:58+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": "71862cfa-38e9-479b-b0db-ac090c9dddb6",
"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-01-12T12:55:58+00:00",
"updated_at": "2025-01-12T12:55:58+00:00",
"completed_at": "2025-01-12T12:55:58+00:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "4fde15b7-1af3-4525-83b9-ee3c213899f5",
"participants_count": 4
},
"created_at": "2025-01-12T12:55:58+00:00",
"updated_at": "2025-01-12T12:55:58+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": "9a8ad2d0-23dd-4d4a-baa4-bfa01a7d3ad5",
"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-01-12T12:55:58+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-01-12T12:55:58+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": "44ce00a4-0987-4084-9a00-dc61217cbbf0",
"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-01-12T12:55:58+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-01-12T12:55:58+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": "28df2d97-fab9-4aef-a96b-cf78c6667197",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-01-12T12:55:58+00:00",
"updated_at": "2025-01-12T12:55:58+00:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"taskable_type": "case"
}