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-10-13",
"taskable_type": "client",
"taskable_uuid": "3b544ea8-af61-485b-ac70-751677597c66",
"task_status_uuid": "3fcbb622-bb3c-4122-9df2-a5dcacb7021d",
"parent_task_uuid": "bdc1f3b8-ad56-4bbc-9447-c9078df530cc",
"assigned_to_uuids": [
"e3e48978-680e-4060-b93a-8dde717cc692",
"67a7aa62-ec85-4c1b-956c-beed25f08aa3",
"4bcd5d9d-428e-4bb5-9f4c-95508c359865"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"4984b76c-ef73-45ce-97a2-71e5f4484be0",
"b0d0064d-502c-45c1-831c-822998836688",
"9c2fe4ff-b26e-487f-b528-2c06ab617ef7"
],
"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-10-13",
"taskable_type": "client",
"taskable_uuid": "3b544ea8-af61-485b-ac70-751677597c66",
"task_status_uuid": "3fcbb622-bb3c-4122-9df2-a5dcacb7021d",
"parent_task_uuid": "bdc1f3b8-ad56-4bbc-9447-c9078df530cc",
"assigned_to_uuids": [
"e3e48978-680e-4060-b93a-8dde717cc692",
"67a7aa62-ec85-4c1b-956c-beed25f08aa3",
"4bcd5d9d-428e-4bb5-9f4c-95508c359865"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"4984b76c-ef73-45ce-97a2-71e5f4484be0",
"b0d0064d-502c-45c1-831c-822998836688",
"9c2fe4ff-b26e-487f-b528-2c06ab617ef7"
],
"is_recurring": true,
"recurring_frequency": "daily"
}
{
"uuid": "047d4bf6-ec1a-4d4d-8ce5-494e1c901af6",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+01:00",
"name": "Document the transaction",
"description": "Document the transaction",
"priority": "high",
"position": 1,
"due_at": "2021-01-01 00:00:00",
"status": {
"uuid": "66d7fff3-885b-4b96-bc2a-b61bf67a842c",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+01:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"taskable_type": "case",
"taskable": {
"uuid": "c35ff782-c04a-4d23-b48b-63d1eeaf0c87",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+01:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "0d5e07c0-a53b-4d3f-9cef-47037f61bb93",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": null,
"name": "Mortgage Plan",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00"
},
"review_at": "2026-10-08T11:55:17+01:00",
"assigned_to_uuids": [
"0e096c16-9c4e-43b1-a553-b2fb2775790c"
],
"group_uuids": [
"a025631a-2d4a-48f7-b6e8-2c5e413f4b45"
],
"completed_at": "2026-10-08T11:55:17+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": "d0e96829-4287-4684-b491-db40f086cbc3",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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-10-08T11:55:21+01:00",
"next_review_date": "2026-10-08T11:55:21+01:00",
"previous_review_date": "2026-10-08T11:55:21+01:00",
"anniversary_review_date": "2026-10-08T11:55:21+01:00",
"terms_of_business_at": "2026-10-08T11:55:21+01:00",
"client_agreement_at": "2026-10-08T11:55:21+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-10-08",
"last_interaction_at": "2026-10-08 11:55:21",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-08T11:55:21+01:00",
"out_of_office_until": "2026-10-08T11:55:21+01:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"task_board_uuid": "e34062e5-d2ac-4b14-a993-59bcb351a761",
"plans": {
"uuid": "3088be6e-e062-4f02-b416-b8f6e9b5ccfd",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00",
"opened_at": "2026-10-08T11:55:21+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-10-08T11:55:21+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-10-08",
"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-10-08",
"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-10-08T11:55:21+01:00",
"original_valued_at": "2026-10-07T11:55:21+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-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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": "08539aec-12a9-45a5-89c2-6fd89fe4fd99",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+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": "a844c630-8247-4b0b-a633-2bfdc86f5ce6",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"assigned_to": [
{
"uuid": "bfd64b01-8ad8-4bfb-a50b-5ce24f69498a",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+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": "a844c630-8247-4b0b-a633-2bfdc86f5ce6",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
}
],
"completed_at": "2021-01-01 00:00:00",
"completed_by": {
"uuid": "92570e5d-d0bc-4c30-a01a-303d14490069",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+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": "a844c630-8247-4b0b-a633-2bfdc86f5ce6",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"workflow_task": {
"uuid": "038bf50b-eb22-4f5f-b86c-fbbf89b13313",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+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": "eb770199-9282-4436-b932-e14ba2c86861",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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": "d0e96829-4287-4684-b491-db40f086cbc3",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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-10-08T11:55:21+01:00",
"next_review_date": "2026-10-08T11:55:21+01:00",
"previous_review_date": "2026-10-08T11:55:21+01:00",
"anniversary_review_date": "2026-10-08T11:55:21+01:00",
"terms_of_business_at": "2026-10-08T11:55:21+01:00",
"client_agreement_at": "2026-10-08T11:55:21+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-10-08",
"last_interaction_at": "2026-10-08 11:55:21",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-08T11:55:21+01:00",
"out_of_office_until": "2026-10-08T11:55:21+01:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"participants": {
"uuid": "d0e96829-4287-4684-b491-db40f086cbc3",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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-10-08T11:55:21+01:00",
"next_review_date": "2026-10-08T11:55:21+01:00",
"previous_review_date": "2026-10-08T11:55:21+01:00",
"anniversary_review_date": "2026-10-08T11:55:21+01:00",
"terms_of_business_at": "2026-10-08T11:55:21+01:00",
"client_agreement_at": "2026-10-08T11:55:21+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-10-08",
"last_interaction_at": "2026-10-08 11:55:21",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-08T11:55:21+01:00",
"out_of_office_until": "2026-10-08T11:55:21+01:00",
"out_of_office_message": "I am away this week. For urgent matters please contact the office.",
"is_pending_fact_find_account": false,
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"tags": {
"uuid": "604dfecd-2a00-44fa-92ea-fef5918c299d",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"location_uuid": "6bb63385-9773-4ca9-af9c-41bc1d04663e",
"parent": {
"uuid": "f1f4e3c1-457e-4e31-9f30-ce50cba670eb",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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": "d1fe7bc3-8bd3-415c-bd9f-d1953d79bc2d",
"is_trigger_task": true
},
"trigger": {
"uuid": "f1f4e3c1-457e-4e31-9f30-ce50cba670eb",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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": "d1fe7bc3-8bd3-415c-bd9f-d1953d79bc2d",
"is_trigger_task": true
},
"trigger_tasks": {
"uuid": "f1f4e3c1-457e-4e31-9f30-ce50cba670eb",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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": "d1fe7bc3-8bd3-415c-bd9f-d1953d79bc2d",
"is_trigger_task": true
},
"sub_tasks": {
"uuid": "f1f4e3c1-457e-4e31-9f30-ce50cba670eb",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+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": "d1fe7bc3-8bd3-415c-bd9f-d1953d79bc2d",
"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-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00"
},
"workflow": {
"uuid": "9fd2db7a-7507-41e8-bbdb-288258fd5dd7",
"created_at": "2026-10-08T11:55:21+01:00",
"updated_at": "2026-10-08T11:55:21+01:00",
"name": "Pension Transfer",
"type": "simple",
"tasks_count": 5
},
"is_trigger_task": true
},
"workflow": {
"uuid": "90324c13-c350-47c0-86a2-59aab2537948",
"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": "5667efce-2042-400e-9692-56bea809644d",
"created_at": "2026-10-08T11:55:17+01:00",
"updated_at": "2026-10-08T11:55:17+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."
]
}
}