Body
-
The name of the task
-
The description of the task
-
The task's priority. Available options: low, medium, high and highest
Value Description low Low medium Medium high High highest Highest Values are
low,medium,high, orhighest. -
The task due date
-
The taskable type. Available Options: client, employee, case, plan
Values are
client,employee,case, orplan. -
The taskable UUID
-
The task status UUID
-
The parent task UUID
-
Array of account UUIDs
-
Additional custom fields
Additional properties are allowed.
-
UUIDs of groups that will be assigned when the task is created.
-
Whether the task should be recurring or not. Subtasks cannot be recurring.
-
The frequency at which the task should recur. This field is required if is_recurring is set to true.
Value Description daily Daily weekly Weekly fortnightly Fortnightly four_weekly Four Weekly monthly Monthly bimonthly Bimonthly quarterly Quarterly biannually Biannually annually Annually weekdays Weekdays Values are
daily,weekly,fortnightly,four_weekly,monthly,bimonthly,quarterly,biannually,annually, orweekdays.
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":"2026-09-02","taskable_type":"client","taskable_uuid":"290c809f-92b6-48e1-81b8-e6ae7a23a3df","task_status_uuid":"f94aec51-2364-4669-b829-f4ac38d6229b","parent_task_uuid":"014e8391-44a3-4814-98f3-da6363fc595d","assigned_to_uuids":["6f6c9c18-f3a8-4ec3-9ae4-5f38c4241828","2764fd2f-f52d-4b06-83d3-ad6a43659ff3","30ce3bd5-ba7a-4b24-bf3f-3c0a31f7d0f8"],"custom_fields":{"favourite_pet":"Dog"},"group_uuids":["35711833-c5fb-46b3-ade2-bcbf95839525","12d47693-494b-45ba-92e1-06b2239d4d66","d5f7635f-4bef-4ff0-bce0-657a4d165ba3"],"is_recurring":true,"recurring_frequency":"daily"}'
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Check details",
"description": "Check details",
"priority": "low",
"due_at": "2026-09-02",
"taskable_type": "client",
"taskable_uuid": "290c809f-92b6-48e1-81b8-e6ae7a23a3df",
"task_status_uuid": "f94aec51-2364-4669-b829-f4ac38d6229b",
"parent_task_uuid": "014e8391-44a3-4814-98f3-da6363fc595d",
"assigned_to_uuids": [
"6f6c9c18-f3a8-4ec3-9ae4-5f38c4241828",
"2764fd2f-f52d-4b06-83d3-ad6a43659ff3",
"30ce3bd5-ba7a-4b24-bf3f-3c0a31f7d0f8"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"35711833-c5fb-46b3-ade2-bcbf95839525",
"12d47693-494b-45ba-92e1-06b2239d4d66",
"d5f7635f-4bef-4ff0-bce0-657a4d165ba3"
],
"is_recurring": true,
"recurring_frequency": "daily"
}
{
"uuid": "a3cb0dcc-8c52-483f-9fc9-fe826a50e81a",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"name": "Document the transaction",
"description": "Document the transaction",
"priority": "high",
"position": 1,
"due_at": "2021-01-01 00:00:00",
"status": {
"uuid": "0d7a728c-b647-457e-bb16-253265f41fca",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"taskable_type": "case",
"taskable": {
"uuid": "6d278b21-b984-4084-bca9-f4f91b2e9440",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "33240477-61b8-4140-a2b2-18d77da782f1",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": null,
"name": "Mortgage Plan",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00"
},
"review_at": "2026-08-28T07:34:59+01:00",
"assigned_to_uuids": [
"3a1ff16f-6257-432c-aa78-6eef9e36a4a0"
],
"group_uuids": [
"32aeace5-31e5-4189-ab41-52f398166e4a"
],
"completed_at": "2026-08-28T07:34:59+01:00",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"status_position": 4,
"participants_count": 4,
"participants": {
"uuid": "b12e3288-fc2d-4647-b6e4-808e582992ac",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"first_contact_date": "2026-08-28T07:35:05+01:00",
"next_review_date": "2026-08-28T07:35:05+01:00",
"previous_review_date": "2026-08-28T07:35:05+01:00",
"anniversary_review_date": "2026-08-28T07:35:05+01:00",
"terms_of_business_at": "2026-08-28T07:35:05+01:00",
"client_agreement_at": "2026-08-28T07:35:05+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-08-28",
"last_interaction_at": "2026-08-28 07:35:05",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-08-28T07:35:05+01:00",
"out_of_office_until": "2026-08-28T07:35:05+01:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"task_board_uuid": "1d0bb6b3-0d84-46e2-8f67-283c2b9c75d8",
"plans": {
"uuid": "eecd1a05-82ee-4a3c-903e-284d1f2f62ac",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"opened_at": "2026-08-28T07:35:05+01:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-08-28T07:35:05+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-08-28",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-08-28",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
}
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"valued_at": "2026-08-28T07:35:05+01:00",
"original_valued_at": "2026-08-27T07:35:05+01:00",
"statistics": {
"recent_growth": 100
},
"is_wrap_product": false,
"is_wrap_child": false,
"can_be_deleted": "false"
},
"custom_fields": {
"uuid": null,
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink."
}
},
"author": {
"uuid": "4c48da1b-1e92-44a3-bc73-b864d755bc30",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "bbebe1dc-bcfb-4078-848e-1293b8f6887d",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"assigned_to": [
{
"uuid": "174c8e7f-ffb2-4a5b-8e9b-904779aa54af",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "bbebe1dc-bcfb-4078-848e-1293b8f6887d",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
}
],
"completed_at": "2021-01-01 00:00:00",
"completed_by": {
"uuid": "d9e098de-98ff-40ee-96c1-7cb6610ffa85",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "bbebe1dc-bcfb-4078-848e-1293b8f6887d",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"workflow_task": {
"uuid": "4c1dff3e-deae-4f3b-bce0-c70323261786",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"task_status": {
"uuid": "f9b23304-445e-4590-9282-fb6a9bcb190e",
"created_at": "2026-08-28T07:35:06+01:00",
"updated_at": "2026-08-28T07:35:06+01:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"author": {
"uuid": "b12e3288-fc2d-4647-b6e4-808e582992ac",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"first_contact_date": "2026-08-28T07:35:05+01:00",
"next_review_date": "2026-08-28T07:35:05+01:00",
"previous_review_date": "2026-08-28T07:35:05+01:00",
"anniversary_review_date": "2026-08-28T07:35:05+01:00",
"terms_of_business_at": "2026-08-28T07:35:05+01:00",
"client_agreement_at": "2026-08-28T07:35:05+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-08-28",
"last_interaction_at": "2026-08-28 07:35:05",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-08-28T07:35:05+01:00",
"out_of_office_until": "2026-08-28T07:35:05+01:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"participants": {
"uuid": "b12e3288-fc2d-4647-b6e4-808e582992ac",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"first_contact_date": "2026-08-28T07:35:05+01:00",
"next_review_date": "2026-08-28T07:35:05+01:00",
"previous_review_date": "2026-08-28T07:35:05+01:00",
"anniversary_review_date": "2026-08-28T07:35:05+01:00",
"terms_of_business_at": "2026-08-28T07:35:05+01:00",
"client_agreement_at": "2026-08-28T07:35:05+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-08-28",
"last_interaction_at": "2026-08-28 07:35:05",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-08-28T07:35:05+01:00",
"out_of_office_until": "2026-08-28T07:35:05+01:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"tags": {
"uuid": "4871f56c-96e4-4a88-98c4-07c3ecb83646",
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"location_uuid": "afb0c947-dec5-46c5-a5eb-405ab7e48fa9",
"parent": {
"uuid": "5feae0d7-f660-41b6-a550-d60e785fa0c5",
"created_at": "2026-08-28T07:35:06+01:00",
"updated_at": "2026-08-28T07:35:06+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "4a7b164e-c0db-4904-b585-f2cbc9f3ff0b",
"is_trigger_task": true
},
"trigger": {
"uuid": "5feae0d7-f660-41b6-a550-d60e785fa0c5",
"created_at": "2026-08-28T07:35:06+01:00",
"updated_at": "2026-08-28T07:35:06+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "4a7b164e-c0db-4904-b585-f2cbc9f3ff0b",
"is_trigger_task": true
},
"trigger_tasks": {
"uuid": "5feae0d7-f660-41b6-a550-d60e785fa0c5",
"created_at": "2026-08-28T07:35:06+01:00",
"updated_at": "2026-08-28T07:35:06+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "4a7b164e-c0db-4904-b585-f2cbc9f3ff0b",
"is_trigger_task": true
},
"sub_tasks": {
"uuid": "5feae0d7-f660-41b6-a550-d60e785fa0c5",
"created_at": "2026-08-28T07:35:06+01:00",
"updated_at": "2026-08-28T07:35:06+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "4a7b164e-c0db-4904-b585-f2cbc9f3ff0b",
"is_trigger_task": true
},
"groups": {
"uuid": null,
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": null,
"description": "UUID of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
}
},
"created_at": "2026-08-28T07:35:05+01:00",
"updated_at": "2026-08-28T07:35:05+01:00"
},
"workflow": {
"uuid": "f5ca0ffe-e2cd-492a-b746-b1f23d6107cb",
"created_at": "2026-08-28T07:35:06+01:00",
"updated_at": "2026-08-28T07:35:06+01:00",
"name": "Pension Transfer",
"type": "simple",
"tasks_count": 5
},
"is_trigger_task": true
},
"workflow": {
"uuid": "f530fc1f-27f2-4cd6-a0d9-4ef5cf9f9b6f",
"name": "New Client Onboarding"
},
"is_recurring": true,
"recurring_frequency": "weekly",
"recurring_last_run": "2026-01-01 00:00:00",
"recurring_next_run": "2026-01-01 00:00:00",
"custom_fields": [
{
"uuid": "31929e4c-cc12-4e0d-b838-ef8cade6dce3",
"created_at": "2026-08-28T07:34:59+01:00",
"updated_at": "2026-08-28T07:34:59+01:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink."
}
]
}
{
"message": "The given data was invalid.",
"errors": {
"field": [
"The field is invalid."
]
}
}