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-07-24","taskable_type":"client","taskable_uuid":"dc683f8f-ebcf-4114-8970-a96e8e8979d3","task_status_uuid":"10f9ce12-6aba-4755-9735-c3eec263d050","parent_task_uuid":"9ecf6ed9-3ea4-4780-9dfc-b1be11e6c90b","assigned_to_uuids":["2890d6b3-6578-4f76-9804-02e617ac5159","b6ef3fc3-d5aa-490b-9896-ba78fded7683","029ab25b-5735-460b-a981-ef57d4db24ed"],"custom_fields":{"favourite_pet":"Dog"},"group_uuids":["5b8faade-b7be-4e09-b776-329c849012c6","0a40657d-1a24-4589-af21-0775d995a63d","659cde6a-6ec1-486d-a50d-62ecdcc6b5ba"],"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-07-24",
"taskable_type": "client",
"taskable_uuid": "dc683f8f-ebcf-4114-8970-a96e8e8979d3",
"task_status_uuid": "10f9ce12-6aba-4755-9735-c3eec263d050",
"parent_task_uuid": "9ecf6ed9-3ea4-4780-9dfc-b1be11e6c90b",
"assigned_to_uuids": [
"2890d6b3-6578-4f76-9804-02e617ac5159",
"b6ef3fc3-d5aa-490b-9896-ba78fded7683",
"029ab25b-5735-460b-a981-ef57d4db24ed"
],
"custom_fields": {
"favourite_pet": "Dog"
},
"group_uuids": [
"5b8faade-b7be-4e09-b776-329c849012c6",
"0a40657d-1a24-4589-af21-0775d995a63d",
"659cde6a-6ec1-486d-a50d-62ecdcc6b5ba"
],
"is_recurring": true,
"recurring_frequency": "daily"
}
{
"uuid": "46a86c22-08b3-4ab8-990a-23358fa38e00",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"name": "Document the transaction",
"description": "Document the transaction",
"priority": "high",
"position": 1,
"due_at": "2021-01-01 00:00:00",
"status": {
"uuid": "54dae6b1-b0a7-4da2-9668-f04d0833ba71",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"taskable_type": "case",
"taskable": {
"uuid": "c6ad7ddb-a08d-4248-9c27-3c2ed3ae2fd8",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "448db5f9-a642-42a5-8a99-7e5a179d16dc",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": null,
"name": "Mortgage Plan",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00"
},
"review_at": "2026-07-17T15:25:29+01:00",
"assigned_to_uuids": [
"e250558a-a4af-41f6-9377-352400d7c4b4"
],
"group_uuids": [
"06e6131c-b98f-454f-bf91-ee2d723ab2dd"
],
"completed_at": "2026-07-17T15:25:29+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": "543b4daa-a2a5-40d9-b97a-af39e3746a8f",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+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-07-17T15:25:36+01:00",
"next_review_date": "2026-07-17T15:25:36+01:00",
"previous_review_date": "2026-07-17T15:25:36+01:00",
"anniversary_review_date": "2026-07-17T15:25:36+01:00",
"terms_of_business_at": "2026-07-17T15:25:36+01:00",
"client_agreement_at": "2026-07-17T15:25:36+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-07-17",
"last_interaction_at": "2026-07-17 15:25:36",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"task_board_uuid": "9b967158-cb95-42a6-9047-7b70b96059fc",
"plans": {
"uuid": "71e659a7-9e83-46b4-ac51-28d5db89ee6b",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"opened_at": "2026-07-17T15:25:36+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-07-17T15:25:36+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-07-17",
"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-07-17",
"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-07-17T15:25:36+01:00",
"original_valued_at": "2026-07-16T15:25:36+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-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+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": "5c538212-5b9d-4528-bda2-01b9b7e92ed4",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+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": "11b7fb3c-bff7-4355-b5d5-6e063a2cdde5",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"assigned_to": [
{
"uuid": "4d5a94a9-081a-479d-96f3-a9914f165e9c",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+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": "11b7fb3c-bff7-4355-b5d5-6e063a2cdde5",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
}
],
"completed_at": "2021-01-01 00:00:00",
"completed_by": {
"uuid": "4a2ae3e8-7845-4257-9bd3-6cf587dab178",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+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": "11b7fb3c-bff7-4355-b5d5-6e063a2cdde5",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"workflow_task": {
"uuid": "aaeeabb7-f081-47de-8936-8dbda8626fca",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+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": "e947ba0e-8b4f-452e-87fa-f6a1ea6d77c1",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+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": "543b4daa-a2a5-40d9-b97a-af39e3746a8f",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+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-07-17T15:25:36+01:00",
"next_review_date": "2026-07-17T15:25:36+01:00",
"previous_review_date": "2026-07-17T15:25:36+01:00",
"anniversary_review_date": "2026-07-17T15:25:36+01:00",
"terms_of_business_at": "2026-07-17T15:25:36+01:00",
"client_agreement_at": "2026-07-17T15:25:36+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-07-17",
"last_interaction_at": "2026-07-17 15:25:36",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"participants": {
"uuid": "543b4daa-a2a5-40d9-b97a-af39e3746a8f",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+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-07-17T15:25:36+01:00",
"next_review_date": "2026-07-17T15:25:36+01:00",
"previous_review_date": "2026-07-17T15:25:36+01:00",
"anniversary_review_date": "2026-07-17T15:25:36+01:00",
"terms_of_business_at": "2026-07-17T15:25:36+01:00",
"client_agreement_at": "2026-07-17T15:25:36+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-07-17",
"last_interaction_at": "2026-07-17 15:25:36",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"tags": {
"uuid": "f1ecba6d-f8a7-415f-90f1-db030dd72262",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"location_uuid": "9e94cd52-365d-4419-a3dd-180ba0ab85c4",
"parent": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+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": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"is_trigger_task": true
},
"trigger": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+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": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"is_trigger_task": true
},
"trigger_tasks": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+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": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"is_trigger_task": true
},
"sub_tasks": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+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": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"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-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00"
},
"workflow": {
"uuid": "40642913-9ca1-435b-a5a1-f4df2b89f3aa",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+01:00",
"name": "Pension Transfer",
"type": "simple",
"tasks_count": 5
},
"is_trigger_task": true
},
"workflow": {
"uuid": "132a7e33-3e23-4457-9b43-e3c1ffae6bac",
"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": "3fb5a2d8-56cf-42f8-a778-6fc311bddb06",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+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."
}
]
}