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-10-15",
"taskable_type": "client",
"taskable_uuid": "983f2853-82e8-40ad-91c9-a4b524de2e46",
"task_status_uuid": "1572c5ce-d310-486c-acf3-77fadac61447",
"parent_task_uuid": "39dc594a-9a1f-4b45-8652-ec5cabab9382",
"assigned_to_uuids": [
"e53c211e-591e-4da0-b5d5-e65767226242",
"40332fa2-2db2-4749-b855-016037ab70cf",
"efb8ba87-0009-4a78-8104-66a4e1392751"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"3f969c7d-b14f-4fda-8694-16d6213db50f",
"4dcc7579-2d4f-4479-b677-18127900fef4",
"c3f5409b-5a64-4a08-9952-64a70029abc4"
],
"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-15",
"taskable_type": "client",
"taskable_uuid": "983f2853-82e8-40ad-91c9-a4b524de2e46",
"task_status_uuid": "1572c5ce-d310-486c-acf3-77fadac61447",
"parent_task_uuid": "39dc594a-9a1f-4b45-8652-ec5cabab9382",
"assigned_to_uuids": [
"e53c211e-591e-4da0-b5d5-e65767226242",
"40332fa2-2db2-4749-b855-016037ab70cf",
"efb8ba87-0009-4a78-8104-66a4e1392751"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"3f969c7d-b14f-4fda-8694-16d6213db50f",
"4dcc7579-2d4f-4479-b677-18127900fef4",
"c3f5409b-5a64-4a08-9952-64a70029abc4"
],
"is_recurring": true,
"recurring_frequency": "daily"
}
{
"uuid": "add21dae-ba29-4f81-9a35-bcbc10e6bca7",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+01:00",
"name": "Document the transaction",
"description": "Document the transaction",
"priority": "high",
"position": 1,
"due_at": "2021-01-01 00:00:00",
"status": {
"uuid": "cb5e1aab-ab3e-4e0a-b090-481fda217b38",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+01:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"taskable_type": "case",
"taskable": {
"uuid": "8b186749-2e92-4dc5-9291-c39b94292bf1",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+01:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "fed781ac-cd3b-465b-872e-748ecdc30aac",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": null,
"name": "Mortgage Plan",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00"
},
"review_at": "2026-10-08T16:24:03+01:00",
"assigned_to_uuids": [
"ed40489d-2e58-4ac9-9dc7-18abcea4d8d1"
],
"group_uuids": [
"9cdd6ce6-cabb-4d46-a39a-0f6f76db0c63"
],
"completed_at": "2026-10-08T16:24:03+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": "1c3191a1-d157-4ac7-bed1-951db7a5961b",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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-08T16:24:08+01:00",
"next_review_date": "2026-10-08T16:24:08+01:00",
"previous_review_date": "2026-10-08T16:24:08+01:00",
"anniversary_review_date": "2026-10-08T16:24:08+01:00",
"terms_of_business_at": "2026-10-08T16:24:08+01:00",
"client_agreement_at": "2026-10-08T16:24:08+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 16:24:08",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-08T16:24:08+01:00",
"out_of_office_until": "2026-10-08T16:24:08+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": "c8ab6dea-60b8-4d6d-b0f9-62ed51c31ce0",
"plans": {
"uuid": "7ea01dae-3b29-4442-bf01-3da145ee8184",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00",
"opened_at": "2026-10-08T16:24:08+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-08T16:24:08+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-08T16:24:08+01:00",
"original_valued_at": "2026-10-07T16:24:08+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-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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": "695dc30c-119e-4ef5-9ee0-b1d7a16099a4",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+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": "e787510a-b280-4850-a22b-0274a00c9970",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"assigned_to": [
{
"uuid": "886f48ab-a72a-4888-a855-da743df694e5",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+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": "e787510a-b280-4850-a22b-0274a00c9970",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
}
],
"completed_at": "2021-01-01 00:00:00",
"completed_by": {
"uuid": "fc356418-11f0-4f7c-a25e-ad7f3ee5d53e",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+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": "e787510a-b280-4850-a22b-0274a00c9970",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"workflow_task": {
"uuid": "5d321aa4-d2a5-4a60-be84-50f77db042ef",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+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": "1a9c4d17-d07a-41e2-8b56-c9dcd2d8c75f",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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": "1c3191a1-d157-4ac7-bed1-951db7a5961b",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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-08T16:24:08+01:00",
"next_review_date": "2026-10-08T16:24:08+01:00",
"previous_review_date": "2026-10-08T16:24:08+01:00",
"anniversary_review_date": "2026-10-08T16:24:08+01:00",
"terms_of_business_at": "2026-10-08T16:24:08+01:00",
"client_agreement_at": "2026-10-08T16:24:08+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 16:24:08",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-08T16:24:08+01:00",
"out_of_office_until": "2026-10-08T16:24:08+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": "1c3191a1-d157-4ac7-bed1-951db7a5961b",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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-08T16:24:08+01:00",
"next_review_date": "2026-10-08T16:24:08+01:00",
"previous_review_date": "2026-10-08T16:24:08+01:00",
"anniversary_review_date": "2026-10-08T16:24:08+01:00",
"terms_of_business_at": "2026-10-08T16:24:08+01:00",
"client_agreement_at": "2026-10-08T16:24:08+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 16:24:08",
"referral_code": "ABC12345",
"is_out_of_office": true,
"out_of_office_from": "2026-10-08T16:24:08+01:00",
"out_of_office_until": "2026-10-08T16:24:08+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": "1b679852-b9ca-4d22-ab98-86fe39921737",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"location_uuid": "62c73e68-f385-4f6c-83d1-3eea10db5063",
"parent": {
"uuid": "21f60cca-9ae5-42d3-867f-b4fd3a8cdcd1",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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": "9b3ed91d-51ae-4aef-b8e4-dff9144d6724",
"is_trigger_task": true
},
"trigger": {
"uuid": "21f60cca-9ae5-42d3-867f-b4fd3a8cdcd1",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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": "9b3ed91d-51ae-4aef-b8e4-dff9144d6724",
"is_trigger_task": true
},
"trigger_tasks": {
"uuid": "21f60cca-9ae5-42d3-867f-b4fd3a8cdcd1",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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": "9b3ed91d-51ae-4aef-b8e4-dff9144d6724",
"is_trigger_task": true
},
"sub_tasks": {
"uuid": "21f60cca-9ae5-42d3-867f-b4fd3a8cdcd1",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+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": "9b3ed91d-51ae-4aef-b8e4-dff9144d6724",
"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-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00"
},
"workflow": {
"uuid": "5d930e48-086b-448f-8af2-3cb5e2c147ef",
"created_at": "2026-10-08T16:24:08+01:00",
"updated_at": "2026-10-08T16:24:08+01:00",
"name": "Pension Transfer",
"type": "simple",
"tasks_count": 5
},
"is_trigger_task": true
},
"workflow": {
"uuid": "4972dd31-4861-44ca-986c-97330d77f5cd",
"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": "a394439c-9e8e-408d-8b2a-d8edd1934582",
"created_at": "2026-10-08T16:24:03+01:00",
"updated_at": "2026-10-08T16:24:03+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."
]
}
}