Update a task Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
PUT /api/v1/task/{uuid}
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required
application/json

Body

  • name string

    The name of the task

  • description string

    The description of the task

  • priority string

    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, or highest.

  • due_at string(date)

    The task due date

  • taskable_type string

    The taskable type. Available Options: client, employee, case, plan

    Values are client, employee, case, or plan.

  • taskable_uuid string(uuid)

    The taskable UUID

  • task_status_uuid string(uuid)

    The task status UUID

  • parent_task_uuid string(uuid)

    The parent task UUID

  • assigned_to_uuids array[string(uuid)]

    Array of account UUIDs

  • custom_fields object

    Additional custom fields

    Additional properties are allowed.

  • group_uuids array[string(uuid)]

    UUIDs of groups that will be assigned when the task is updated.

  • is_recurring boolean

    Whether the task should be recurring or not. Subtasks cannot be recurring.

  • recurring_frequency string

    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, or weekdays.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      The name of the task

    • description string

      The description of the task

    • priority string

      The priority of the task. Available Options: low, medium, high and highest

    • position integer

      The position of the task

    • due_at string

      The due date of the task

    • status object

      The status of the task. Can be any of the task statuses defined in the firm's settings

      Hide status attributes Show status attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • colour string
      • position integer
      • is_type_completed boolean
      • is_archived boolean
      • is_not_started boolean
    • taskable_type string

      The type of the taskable. Available options: client, employee, case, plan

    • taskable object

      The type of the taskable.

      Hide taskable attributes Show taskable attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • status object
        Hide status attributes Show status attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the status.

        • colour

          The colour of the status.

        • position

          The position of the status.

        • is_type_completed

          Indicates if the status is for a completed case type.

      • type object
        Hide type attributes Show type attributes object
        • uuid

          The UUID of the type

        • name

          Name of the type

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

      • review_at string
      • assigned_to_uuids array[string]
      • group_uuids array[string]
      • completed_at string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • status_position integer
      • participants_count integer
      • participants object
        Hide participants attributes Show participants attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • permissions

          Permission map where keys are permission names and values are target arrays

      • task_board_uuid string
      • plans object
        Hide plans attributes Show plans attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • opened_at

          Timestamp of when the plan was originally opened

        • name

          Name of the plan

        • type

          Type of plan, this will indicate what to expect from the fields attribute

        • sub_type

          Plan sub type

        • abstract_type

          describes if the plan is an asset, protection or liability

        • policy_number

          The policy number on the main sub account of the plan

        • proposal_reference

          The proposal reference on the main sub account of the plan

        • status

          Plan status

        • inactive_at

          Timestamp of when the plan became inactive

        • inactive_reason

          Reason for inactivity

        • agency_in_your_name

          Denotes if plan has agency in your name

        • agency_in_your_name_from

          Date the agency was in your name from

        • originally_sold_by_firm

          Denotes if the plan was originally sold by your firm

        • under_advice

          Denotes if plan is under advice

        • visible_on_client_portal

          Denotes if this plan is visible to clients on the client portal

        • include_in_client_valuation

          Denotes if this plan should be included in the client valuation

        • show_on_joint

          Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

        • shown_on_circles

          Determines if plan should be shown on a circle

        • review_date

          Review date

        • on_panel

          On panel

        • is_group_scheme

          Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes.

        • is_sub_group_scheme

          Denotes if the plan is a sub-scheme of a group scheme.

        • is_group_scheme_member

          Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

        • advice_area

          The advice area of the plan based on the plan's sub type.

        • total_benefit_amount

          Total amount benefit of all covers

        • total_benefits

          Total benefits broken down in to cover types

        • value

          Total value of the plan

        • valued_at

          When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

        • original_valued_at

          When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

        • statistics

          The statistics on a plan. Only displayed when you retrieve an individual plan

        • is_wrap_product

          Determines if the plan is a wrap plan

        • is_wrap_child

          Determines if the plan is a wrap child

        • can_be_deleted

          Denotes if the plan can be deleted

      • custom_fields object
        Hide custom_fields attributes Show custom_fields attributes object
        • uuid

          The UUID of the custom field

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          The type of custom field

        • name

          The name of the custom field

        • reference

          The reference of the custom field, used when updating the custom field on the model.

        • is_required

          Denotes if the custom field is required

        • value

          The value of the custom field

        • selection_options

          This is the array of available options for the selection box. If the type is "selection" this array will be provided.

        • help_text

          Optional help text to aide the custom field. Will be displayed on Plannr.

    • author object

      The account that created the task

      Hide author attributes Show author attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • assigned_to array[object]

      The accounts that the task is assigned to

      Hide assigned_to attributes Show assigned_to attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • completed_at string

      The date the task was completed

    • completed_by object

      The account that completed the task

      Hide completed_by attributes Show completed_by attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.

    • workflow_task object

      The workflow task associated with this task

      Hide workflow_task attributes Show workflow_task attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • description string
      • priority string
      • position integer
      • task_status object
        Hide task_status attributes Show task_status attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the status

        • colour

          Status colour

        • position

          The position of the status

        • is_type_completed

          Whether the status is a completed status

        • is_archived

          Whether the status is a archived status

        • is_not_started

          Whether the status is a not started status

      • offset_due_at_by integer
      • visible_to_clients boolean
      • auto_assign_assigned_adviser boolean
      • auto_assign_assigned_administrator boolean
      • auto_assign_clients boolean
      • author object
        Hide author attributes Show author attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • permissions

          Permission map where keys are permission names and values are target arrays

      • participants object
        Hide participants attributes Show participants attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • permissions

          Permission map where keys are permission names and values are target arrays

      • tags object
        Hide tags attributes Show tags attributes object
        • uuid

          UUID of the tag

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the tag

        • slug

          The slug of the tag

        • colour

          The colour of the tag

      • location_uuid string
      • parent object
        Hide parent attributes Show parent attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the task

        • description

          The extra description added to a task

        • priority

          The priority level of the task (e.g p1, p2, p3, p4)

        • position

          The task position.

        • offset_due_at_by

          How many days from the day the workflow is run should the due at be set by.

        • visible_to_clients

          Indicator for if the task is visible to clients.

        • auto_assign_assigned_adviser

          Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created.

        • auto_assign_assigned_administrator

          Denotes if the task will auto-assign the administrator of the client when it is created.

        • auto_assign_clients

          Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned.

        • location_uuid

          The parent task or workflow trigger task this task is a child of.

        • is_trigger_task

          Denotes if this is a triggered task.

      • trigger object
        Hide trigger attributes Show trigger attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the task

        • description

          The extra description added to a task

        • priority

          The priority level of the task (e.g p1, p2, p3, p4)

        • position

          The task position.

        • offset_due_at_by

          How many days from the day the workflow is run should the due at be set by.

        • visible_to_clients

          Indicator for if the task is visible to clients.

        • auto_assign_assigned_adviser

          Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created.

        • auto_assign_assigned_administrator

          Denotes if the task will auto-assign the administrator of the client when it is created.

        • auto_assign_clients

          Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned.

        • location_uuid

          The parent task or workflow trigger task this task is a child of.

        • is_trigger_task

          Denotes if this is a triggered task.

      • trigger_tasks object
        Hide trigger_tasks attributes Show trigger_tasks attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the task

        • description

          The extra description added to a task

        • priority

          The priority level of the task (e.g p1, p2, p3, p4)

        • position

          The task position.

        • offset_due_at_by

          How many days from the day the workflow is run should the due at be set by.

        • visible_to_clients

          Indicator for if the task is visible to clients.

        • auto_assign_assigned_adviser

          Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created.

        • auto_assign_assigned_administrator

          Denotes if the task will auto-assign the administrator of the client when it is created.

        • auto_assign_clients

          Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned.

        • location_uuid

          The parent task or workflow trigger task this task is a child of.

        • is_trigger_task

          Denotes if this is a triggered task.

      • sub_tasks object
        Hide sub_tasks attributes Show sub_tasks attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the task

        • description

          The extra description added to a task

        • priority

          The priority level of the task (e.g p1, p2, p3, p4)

        • position

          The task position.

        • offset_due_at_by

          How many days from the day the workflow is run should the due at be set by.

        • visible_to_clients

          Indicator for if the task is visible to clients.

        • auto_assign_assigned_adviser

          Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created.

        • auto_assign_assigned_administrator

          Denotes if the task will auto-assign the administrator of the client when it is created.

        • auto_assign_clients

          Denotes if the task will auto-assign the clients when it is created. If the workflow is run on a case then all the clients on the case will be assigned.

        • location_uuid

          The parent task or workflow trigger task this task is a child of.

        • is_trigger_task

          Denotes if this is a triggered task.

      • groups object
        Hide groups attributes Show groups attributes object
        • uuid

          UUID of the group

        • name

          Name of the group

        • slug

          Slug of the group

        • participants_count

          Number of participants in the group

        • participants

          Participants in this group

        • created_at

          Timestamp of when the group was created

        • updated_at

          Timestamp of when the group was updated

      • workflow object
        Hide workflow attributes Show workflow attributes object
        • uuid

          UUID of the account

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          Name of the workflow

        • type

          The type of workflow.

        • tasks_count

          The number of tasks on the workflow.

      • is_trigger_task boolean
    • workflow object

      The Workflow this Task was created from, or null when the Task did not come from a Workflow.

      Hide workflow attributes Show workflow attributes object
      • uuid string
      • name string
    • is_recurring boolean

      Whether the task is recurring or not

    • recurring_frequency string

      The frequency of the recurrence.

    • recurring_last_run string

      The last time the recurring task was run

    • recurring_next_run string

      The next time the recurring task will be run

    • custom_fields array[object]

      Any custom fields on the model.

      Hide custom_fields attributes Show custom_fields attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • reference string
      • is_required boolean
      • value string
      • selection_options array[string]
      • help_text string
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
PUT /api/v1/task/{uuid} 
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-08-21","taskable_type":"client","taskable_uuid":"5d7c224f-8b74-46a8-b8a0-95ec3101d33b","task_status_uuid":"c39c8ee3-7a8c-41ee-9f16-f6a79123c19b","parent_task_uuid":"a1d4d673-6162-43e0-88c1-de1dfada7360","assigned_to_uuids":["68d3bb4b-cb08-4cc8-b93a-35d1241e4a0c","46a6d9b0-3790-4b84-ac6c-87823c5cc9af","1016e9dd-98f1-4330-a854-cdfdb248a043"],"custom_fields":{"favourite_pet":"Dog"},"group_uuids":["9508f15f-3e75-416c-b4e0-07556da7c229","4b09f814-50cf-4d71-a29d-b8b6e48447e9","3ba12370-1c10-4d41-b88f-c32a190aadaa"],"is_recurring":true,"recurring_frequency":"daily"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Check details",
  "description": "Check details",
  "priority": "low",
  "due_at": "2026-08-21",
  "taskable_type": "client",
  "taskable_uuid": "5d7c224f-8b74-46a8-b8a0-95ec3101d33b",
  "task_status_uuid": "c39c8ee3-7a8c-41ee-9f16-f6a79123c19b",
  "parent_task_uuid": "a1d4d673-6162-43e0-88c1-de1dfada7360",
  "assigned_to_uuids": [
    "68d3bb4b-cb08-4cc8-b93a-35d1241e4a0c",
    "46a6d9b0-3790-4b84-ac6c-87823c5cc9af",
    "1016e9dd-98f1-4330-a854-cdfdb248a043"
  ],
  "custom_fields": {
    "favourite_pet": "Dog"
  },
  "group_uuids": [
    "9508f15f-3e75-416c-b4e0-07556da7c229",
    "4b09f814-50cf-4d71-a29d-b8b6e48447e9",
    "3ba12370-1c10-4d41-b88f-c32a190aadaa"
  ],
  "is_recurring": true,
  "recurring_frequency": "daily"
}
Response examples (200) 
{
  "uuid": "e3f34ab1-59af-4bca-a0aa-73a8e88e0c89",
  "created_at": "2026-08-14T11:20:12+01:00",
  "updated_at": "2026-08-14T11:20:12+01:00",
  "name": "Document the transaction",
  "description": "Document the transaction",
  "priority": "high",
  "position": 1,
  "due_at": "2021-01-01 00:00:00",
  "status": {
    "uuid": "e61dac69-6cb1-4249-a417-bfa004b93e71",
    "created_at": "2026-08-14T11:20:12+01:00",
    "updated_at": "2026-08-14T11:20:12+01:00",
    "name": "Incomplete",
    "colour": "#398898",
    "position": 1,
    "is_type_completed": false,
    "is_archived": false,
    "is_not_started": false
  },
  "taskable_type": "case",
  "taskable": {
    "uuid": "24eb1fc4-018e-4440-8309-4fb9ca894af4",
    "created_at": "2026-08-14T11:20:12+01:00",
    "updated_at": "2026-08-14T11:20:12+01:00",
    "name": "finance",
    "slug": "finance",
    "status": {
      "uuid": "fdda5322-1de1-4163-b521-10bd223b1c4e",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00",
      "name": "To Be Reviewed",
      "colour": "#23852B",
      "position": 5,
      "is_type_completed": false
    },
    "type": {
      "uuid": null,
      "name": "Mortgage Plan",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00"
    },
    "review_at": "2026-08-14T11:20:12+01:00",
    "assigned_to_uuids": [
      "98d6da62-a6e7-437d-9a71-0ec5ee25eda2"
    ],
    "group_uuids": [
      "d59e1bdb-477d-4aaa-8351-c3c986e80d56"
    ],
    "completed_at": "2026-08-14T11:20:12+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": "d2346226-657c-4af4-bea0-402fab0fdfab",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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-14T11:20:18+01:00",
      "next_review_date": "2026-08-14T11:20:18+01:00",
      "previous_review_date": "2026-08-14T11:20:18+01:00",
      "anniversary_review_date": "2026-08-14T11:20:18+01:00",
      "terms_of_business_at": "2026-08-14T11:20:18+01:00",
      "client_agreement_at": "2026-08-14T11:20:18+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-08-14",
      "last_interaction_at": "2026-08-14 11:20:18",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-08-14T11:20:18+01:00",
      "out_of_office_until": "2026-08-14T11:20:18+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": "8259650b-5d8e-46a3-ae90-2fafb4e0955a",
    "plans": {
      "uuid": "aaa2c5fa-8582-411b-8b5b-90ff9f36ee30",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00",
      "opened_at": "2026-08-14T11:20:18+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-14T11:20:18+01:00",
      "inactive_reason": "claimed",
      "agency_in_your_name": true,
      "agency_in_your_name_from": "2025-08-14",
      "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-14",
      "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-14T11:20:18+01:00",
      "original_valued_at": "2026-08-13T11:20:18+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-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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": "c4eb373d-1cb2-41f1-b4b7-3f8187a58fe1",
    "created_at": "2026-08-14T11:20:12+01:00",
    "updated_at": "2026-08-14T11:20:12+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": "00f4c9a4-102c-49e4-988a-8423e6bf955f",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "assigned_to": [
    {
      "uuid": "b3288aba-d945-4de6-8397-b8b7fb6ae08c",
      "created_at": "2026-08-14T11:20:12+01:00",
      "updated_at": "2026-08-14T11:20:12+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": "00f4c9a4-102c-49e4-988a-8423e6bf955f",
        "created_at": "2026-08-14T11:20:18+01:00",
        "updated_at": "2026-08-14T11:20:18+01:00",
        "third_party": "nucleus",
        "reference": "AB123456"
      }
    }
  ],
  "completed_at": "2021-01-01 00:00:00",
  "completed_by": {
    "uuid": "f5f76893-aff6-4341-80cc-e02d306e4a7d",
    "created_at": "2026-08-14T11:20:12+01:00",
    "updated_at": "2026-08-14T11:20:12+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": "00f4c9a4-102c-49e4-988a-8423e6bf955f",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "workflow_task": {
    "uuid": "c77dd891-4d06-4dec-b49f-897fb860305f",
    "created_at": "2026-08-14T11:20:12+01:00",
    "updated_at": "2026-08-14T11:20:12+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": "5693df13-d838-4ac5-9767-658e0730d611",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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": "d2346226-657c-4af4-bea0-402fab0fdfab",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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-14T11:20:18+01:00",
      "next_review_date": "2026-08-14T11:20:18+01:00",
      "previous_review_date": "2026-08-14T11:20:18+01:00",
      "anniversary_review_date": "2026-08-14T11:20:18+01:00",
      "terms_of_business_at": "2026-08-14T11:20:18+01:00",
      "client_agreement_at": "2026-08-14T11:20:18+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-08-14",
      "last_interaction_at": "2026-08-14 11:20:18",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-08-14T11:20:18+01:00",
      "out_of_office_until": "2026-08-14T11:20:18+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": "d2346226-657c-4af4-bea0-402fab0fdfab",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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-14T11:20:18+01:00",
      "next_review_date": "2026-08-14T11:20:18+01:00",
      "previous_review_date": "2026-08-14T11:20:18+01:00",
      "anniversary_review_date": "2026-08-14T11:20:18+01:00",
      "terms_of_business_at": "2026-08-14T11:20:18+01:00",
      "client_agreement_at": "2026-08-14T11:20:18+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-08-14",
      "last_interaction_at": "2026-08-14 11:20:18",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-08-14T11:20:18+01:00",
      "out_of_office_until": "2026-08-14T11:20:18+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": "ce48289b-7578-48ac-8b06-e124949c7019",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    },
    "location_uuid": "7268bfbf-ebb2-4176-9454-a1936126f535",
    "parent": {
      "uuid": "6ecd9990-b6bb-4962-9653-5c751031f777",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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": "b2cbf781-11e0-49bb-95fa-5ecfa4955c2c",
      "is_trigger_task": true
    },
    "trigger": {
      "uuid": "6ecd9990-b6bb-4962-9653-5c751031f777",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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": "b2cbf781-11e0-49bb-95fa-5ecfa4955c2c",
      "is_trigger_task": true
    },
    "trigger_tasks": {
      "uuid": "6ecd9990-b6bb-4962-9653-5c751031f777",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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": "b2cbf781-11e0-49bb-95fa-5ecfa4955c2c",
      "is_trigger_task": true
    },
    "sub_tasks": {
      "uuid": "6ecd9990-b6bb-4962-9653-5c751031f777",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+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": "b2cbf781-11e0-49bb-95fa-5ecfa4955c2c",
      "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-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00"
    },
    "workflow": {
      "uuid": "1fb5aa8d-f2a7-4d94-af21-ad1962185f87",
      "created_at": "2026-08-14T11:20:18+01:00",
      "updated_at": "2026-08-14T11:20:18+01:00",
      "name": "Pension Transfer",
      "type": "simple",
      "tasks_count": 5
    },
    "is_trigger_task": true
  },
  "workflow": {
    "uuid": "db1a4d3f-21ea-4318-83b0-4775877f40d3",
    "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": "f62a91bd-0c0f-4ee8-84bd-3969136ae2e3",
      "created_at": "2026-08-14T11:20:12+01:00",
      "updated_at": "2026-08-14T11:20:12+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."
    }
  ]
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}