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 updated.
-
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 PUT 'https://api.plannrcrm.com/api/v1/task/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--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-11-04",
"taskable_type": "client",
"taskable_uuid": "eeb49f1d-fd50-4cb5-891c-b9283c300ea4",
"task_status_uuid": "345bb066-f1ff-4a64-84a3-39546d236367",
"parent_task_uuid": "c2a51065-8550-4613-a7a0-b4e6de0769e4",
"assigned_to_uuids": [
"c1310cb7-77d7-4009-8254-2d0ee9ad49f7",
"d6275502-c303-4735-a61c-ca0221d46ac9",
"cc5c89ce-28bb-40cf-b682-d684880ad93e"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"12af05d8-18b2-4591-abe3-38a6e66cac17",
"9a53bbe5-c25f-45b1-afdb-c865aa3c36d2",
"ce749074-54f6-4c7d-bdd5-5848ba2ae73f"
],
"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-11-04",
"taskable_type": "client",
"taskable_uuid": "eeb49f1d-fd50-4cb5-891c-b9283c300ea4",
"task_status_uuid": "345bb066-f1ff-4a64-84a3-39546d236367",
"parent_task_uuid": "c2a51065-8550-4613-a7a0-b4e6de0769e4",
"assigned_to_uuids": [
"c1310cb7-77d7-4009-8254-2d0ee9ad49f7",
"d6275502-c303-4735-a61c-ca0221d46ac9",
"cc5c89ce-28bb-40cf-b682-d684880ad93e"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"12af05d8-18b2-4591-abe3-38a6e66cac17",
"9a53bbe5-c25f-45b1-afdb-c865aa3c36d2",
"ce749074-54f6-4c7d-bdd5-5848ba2ae73f"
],
"is_recurring": true,
"recurring_frequency": "daily"
}
{
"uuid": "338cc3dd-18e7-4cd1-a3ea-055b22a5e92f",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00:00",
"name": "Document the transaction",
"description": "Document the transaction",
"priority": "high",
"position": 1,
"due_at": "2021-01-01 00:00:00",
"status": {
"uuid": "e8de0f6c-a705-4b3a-9fd8-9f53a1bad81c",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"taskable_type": "case",
"taskable": {
"uuid": "2695ee79-797b-4cda-9ed1-cf2462b48c63",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "dcf6a0de-7ba0-42ca-8ce1-a1a77ac6352a",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": null,
"name": "Mortgage Plan",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00"
},
"review_at": "2026-10-28T10:39:28+00:00",
"assigned_to_uuids": [
"70cea164-c490-417e-aee9-70d4f7946055"
],
"group_uuids": [
"ffed0cb0-cae8-47ab-be72-5f93676da617"
],
"completed_at": "2026-10-28T10:39:28+00: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": "3a8f910e-498c-4ef0-aac6-2403351a702c",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00: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-28T10:39:33+00:00",
"next_review_date": "2026-10-28T10:39:33+00:00",
"previous_review_date": "2026-10-28T10:39:33+00:00",
"anniversary_review_date": "2026-10-28T10:39:33+00:00",
"terms_of_business_at": "2026-10-28T10:39:33+00:00",
"client_agreement_at": "2026-10-28T10:39:33+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-10-28",
"last_interaction_at": "2026-10-28 10:39:33",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-28T10:39:33+00:00",
"out_of_office_until": "2026-10-28T10:39:33+00: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"
]
},
"managed_by_head_office": false
},
"task_board_uuid": "127a760a-a871-4dc4-b0e1-4294a27ed369",
"plans": {
"uuid": "34122ea1-40e3-4582-88f3-f4c28ddd0836",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00",
"opened_at": "2026-10-28T10:39:33+00: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-28T10:39:33+00:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-10-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-10-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-10-28T10:39:33+00:00",
"original_valued_at": "2026-10-27T10:39:33+00: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-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00: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": "c6ad4baa-e7ba-452d-bf41-76d9bcdd873c",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00: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": "aa9d829d-1801-43a0-b785-5f68dad9f6d1",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"assigned_to": [
{
"uuid": "fb7bfc25-7588-46de-a97d-cd1cddc63632",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00: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": "aa9d829d-1801-43a0-b785-5f68dad9f6d1",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
}
],
"completed_at": "2021-01-01 00:00:00",
"completed_by": {
"uuid": "835b0cb5-fc74-45c0-bec2-a0b282f18bad",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00: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": "aa9d829d-1801-43a0-b785-5f68dad9f6d1",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"workflow_task": {
"uuid": "6eace87d-16d6-413b-a89c-c34dbeafb672",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00: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": "bf667028-0d9c-43dd-9ab2-f9e97227438d",
"created_at": "2026-10-28T10:39:34+00:00",
"updated_at": "2026-10-28T10:39:34+00: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": "3a8f910e-498c-4ef0-aac6-2403351a702c",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00: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-28T10:39:33+00:00",
"next_review_date": "2026-10-28T10:39:33+00:00",
"previous_review_date": "2026-10-28T10:39:33+00:00",
"anniversary_review_date": "2026-10-28T10:39:33+00:00",
"terms_of_business_at": "2026-10-28T10:39:33+00:00",
"client_agreement_at": "2026-10-28T10:39:33+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-10-28",
"last_interaction_at": "2026-10-28 10:39:33",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-28T10:39:33+00:00",
"out_of_office_until": "2026-10-28T10:39:33+00: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"
]
},
"managed_by_head_office": false
},
"participants": {
"uuid": "3a8f910e-498c-4ef0-aac6-2403351a702c",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00: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-28T10:39:33+00:00",
"next_review_date": "2026-10-28T10:39:33+00:00",
"previous_review_date": "2026-10-28T10:39:33+00:00",
"anniversary_review_date": "2026-10-28T10:39:33+00:00",
"terms_of_business_at": "2026-10-28T10:39:33+00:00",
"client_agreement_at": "2026-10-28T10:39:33+00:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-10-28",
"last_interaction_at": "2026-10-28 10:39:33",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-28T10:39:33+00:00",
"out_of_office_until": "2026-10-28T10:39:33+00: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"
]
},
"managed_by_head_office": false
},
"tags": {
"uuid": "cda165d5-73b8-41fd-b8a5-a83e6aba0e91",
"created_at": "2026-10-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"location_uuid": "ab226742-c33f-4395-adb6-da049900c627",
"parent": {
"uuid": "254d1550-1813-44e7-8d79-c2409b6dcb2a",
"created_at": "2026-10-28T10:39:34+00:00",
"updated_at": "2026-10-28T10:39:34+00: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": "a2a95a32-4634-4045-8a97-4ef7072283c4",
"is_trigger_task": true
},
"trigger": {
"uuid": "254d1550-1813-44e7-8d79-c2409b6dcb2a",
"created_at": "2026-10-28T10:39:34+00:00",
"updated_at": "2026-10-28T10:39:34+00: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": "a2a95a32-4634-4045-8a97-4ef7072283c4",
"is_trigger_task": true
},
"trigger_tasks": {
"uuid": "254d1550-1813-44e7-8d79-c2409b6dcb2a",
"created_at": "2026-10-28T10:39:34+00:00",
"updated_at": "2026-10-28T10:39:34+00: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": "a2a95a32-4634-4045-8a97-4ef7072283c4",
"is_trigger_task": true
},
"sub_tasks": {
"uuid": "254d1550-1813-44e7-8d79-c2409b6dcb2a",
"created_at": "2026-10-28T10:39:34+00:00",
"updated_at": "2026-10-28T10:39:34+00: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": "a2a95a32-4634-4045-8a97-4ef7072283c4",
"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-28T10:39:33+00:00",
"updated_at": "2026-10-28T10:39:33+00:00"
},
"workflow": {
"uuid": "013ab64f-ec74-4d0d-a577-588bba7816ef",
"created_at": "2026-10-28T10:39:34+00:00",
"updated_at": "2026-10-28T10:39:34+00:00",
"name": "Pension Transfer",
"type": "simple",
"tasks_count": 5,
"network_locked": false
},
"is_trigger_task": true
},
"workflow": {
"uuid": "8d850b3d-25cc-4c8e-bbe8-5cb7aa9cd29a",
"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": "c36f6d35-18c3-4360-9881-439b6079576d",
"created_at": "2026-10-28T10:39:28+00:00",
"updated_at": "2026-10-28T10:39:28+00: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."
]
}
}