PATCH /api/v1/task/{task_uuid}/complete
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • task_uuid string Required

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, 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 string
      • type string
      • 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 string
      • task_board_uuid string
      • plans string
      • custom_fields string
    • author object

      The account that created the task

      Hide author attributes Show author attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
        • collection boolean
      • created_at object
        Hide created_at attributes Show created_at attributes object
        • example string
        • description string
        • collection boolean
      • updated_at object
        Hide updated_at attributes Show updated_at attributes object
        • example string
        • description string
        • collection boolean
      • type object
        Hide type attributes Show type attributes object
        • example string
        • description string
        • collection boolean
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
        • collection boolean
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
        • collection boolean
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
        • collection boolean
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
        • collection boolean
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
        • collection boolean
      • photo_url object
        Hide photo_url attributes Show photo_url attributes object
        • example string
        • description string
        • collection boolean
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • example string
        • description string
        • collection boolean
    • assigned_to object

      The accounts that the task is assigned to

      Hide assigned_to attributes Show assigned_to attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
        • collection boolean
      • created_at object
        Hide created_at attributes Show created_at attributes object
        • example string
        • description string
        • collection boolean
      • updated_at object
        Hide updated_at attributes Show updated_at attributes object
        • example string
        • description string
        • collection boolean
      • type object
        Hide type attributes Show type attributes object
        • example string
        • description string
        • collection boolean
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
        • collection boolean
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
        • collection boolean
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
        • collection boolean
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
        • collection boolean
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
        • collection boolean
      • photo_url object
        Hide photo_url attributes Show photo_url attributes object
        • example string
        • description string
        • collection boolean
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • example string
        • description string
        • collection boolean
    • 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 object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
        • collection boolean
      • created_at object
        Hide created_at attributes Show created_at attributes object
        • example string
        • description string
        • collection boolean
      • updated_at object
        Hide updated_at attributes Show updated_at attributes object
        • example string
        • description string
        • collection boolean
      • type object
        Hide type attributes Show type attributes object
        • example string
        • description string
        • collection boolean
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
        • collection boolean
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
        • collection boolean
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
        • collection boolean
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
        • collection boolean
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
        • collection boolean
      • photo_url object
        Hide photo_url attributes Show photo_url attributes object
        • example string
        • description string
        • collection boolean
      • external_references object
        Hide external_references attributes Show external_references attributes object
        • example string
        • description string
        • collection boolean
    • workflow_task object

      The workflow task associated with this task

      Hide workflow_task attributes Show workflow_task attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
        • collection boolean
      • created_at object
        Hide created_at attributes Show created_at attributes object
        • example string
        • description string
        • collection boolean
      • updated_at object
        Hide updated_at attributes Show updated_at attributes object
        • example string
        • description string
        • collection boolean
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
        • collection boolean
      • description object
        Hide description attributes Show description attributes object
        • example string
        • description string
        • collection boolean
      • priority object
        Hide priority attributes Show priority attributes object
        • example string
        • description string
        • collection boolean
      • position object
        Hide position attributes Show position attributes object
        • example integer
        • description string
        • collection boolean
      • task_status object
        Hide task_status attributes Show task_status attributes object
        • example string
        • description string
        • collection boolean
      • offset_due_at_by object
        Hide offset_due_at_by attributes Show offset_due_at_by attributes object
        • example integer
        • description string
        • collection boolean
      • visible_to_clients object
        Hide visible_to_clients attributes Show visible_to_clients attributes object
        • example boolean
        • description string
        • collection boolean
      • auto_assign_assigned_adviser object
        Hide auto_assign_assigned_adviser attributes Show auto_assign_assigned_adviser attributes object
        • example boolean
        • description string
        • collection boolean
      • auto_assign_assigned_administrator object
        Hide auto_assign_assigned_administrator attributes Show auto_assign_assigned_administrator attributes object
        • example boolean
        • description string
        • collection boolean
      • auto_assign_clients object
        Hide auto_assign_clients attributes Show auto_assign_clients attributes object
        • example boolean
        • description string
        • collection boolean
      • author object
        Hide author attributes Show author attributes object
        • example string
        • description string
        • collection boolean
      • participants object
        Hide participants attributes Show participants attributes object
        • example string
        • description string
        • collection boolean
      • tags object
        Hide tags attributes Show tags attributes object
        • example string
        • description string
        • collection boolean
      • location_uuid object
        Hide location_uuid attributes Show location_uuid attributes object
        • example string
        • description string
        • collection boolean
      • parent object
        Hide parent attributes Show parent attributes object
        • example string
        • description string
        • collection boolean
      • trigger object
        Hide trigger attributes Show trigger attributes object
        • example string
        • description string
        • collection boolean
      • trigger_tasks object
        Hide trigger_tasks attributes Show trigger_tasks attributes object
        • example string
        • description string
        • collection boolean
      • sub_tasks object
        Hide sub_tasks attributes Show sub_tasks attributes object
        • example string
        • description string
        • collection boolean
      • groups object
        Hide groups attributes Show groups attributes object
        • example string
        • description string
        • collection boolean
      • workflow object
        Hide workflow attributes Show workflow attributes object
        • example string
        • description string
        • collection boolean
      • is_trigger_task object
        Hide is_trigger_task attributes Show is_trigger_task attributes object
        • example boolean
        • description string
        • collection boolean
    • 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
PATCH /api/v1/task/{task_uuid}/complete 
curl \
 --request PATCH 'https://api.plannrcrm.com/api/v1/task/6ff8f7f6-1eb3-3525-be4a-3932c805afed/complete' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
Document the transaction 
{
  "name": "Document the transaction",
  "uuid": "32d2ca8e-338b-46b1-a503-cc57a9b20b43",
  "author": {
    "name": {
      "example": "Gareth Thompson",
      "collection": false,
      "description": "Name"
    },
    "role": {
      "example": "client",
      "collection": false,
      "description": "Account role"
    },
    "type": {
      "example": "client",
      "collection": false,
      "description": "Account type"
    },
    "uuid": {
      "example": "53e8daa4-f989-446b-a135-13d006aa2d03",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
    },
    "last_name": {
      "example": "Thompson",
      "collection": false,
      "description": "Last name"
    },
    "photo_url": {
      "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "collection": false,
      "description": "The photo URL of the client"
    },
    "created_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was updated."
    },
    "external_references": {
      "example": "App\\Http\\Resources\\ExternalReferenceResource",
      "collection": true,
      "description": "The external references that have been added to the client."
    }
  },
  "due_at": "2021-01-01 00:00:00",
  "status": {
    "name": "Incomplete",
    "uuid": "11b4bae3-29d6-4669-954b-f6cc976462fe",
    "colour": "#398898",
    "position": 1,
    "created_at": "2026-04-08T15:40:47+01:00",
    "updated_at": "2026-04-08T15:40:47+01:00",
    "is_archived": false,
    "is_not_started": false,
    "is_type_completed": false
  },
  "position": 1,
  "priority": "high",
  "taskable": {
    "name": "finance",
    "slug": "finance",
    "type": "App\\Http\\Resources\\CasesTypeResource",
    "uuid": "5d63a599-63a9-4ed1-9949-2d5d6d0fb6a5",
    "plans": "App\\Http\\Resources\\Plans\\PlanResource",
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "status": "App\\Http\\Resources\\CasesStatusResource",
    "review_at": "2026-04-08T15:40:47+01:00",
    "created_at": "2026-04-08T15:40:47+01:00",
    "updated_at": "2026-04-08T15:40:47+01:00",
    "group_uuids": [
      "29d65f22-41c7-4e42-89c5-7b8658af00a5"
    ],
    "completed_at": "2026-04-08T15:40:47+01:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "0bc658c4-803a-4a56-b639-87430021c8d9",
    "assigned_to_uuids": [
      "de1951db-a093-47b5-8274-66019f60aa99"
    ],
    "participants_count": 4
  },
  "created_at": "2026-04-08T15:40:47+01:00",
  "updated_at": "2026-04-08T15:40:47+01:00",
  "assigned_to": {
    "name": {
      "example": "Gareth Thompson",
      "collection": false,
      "description": "Name"
    },
    "role": {
      "example": "client",
      "collection": false,
      "description": "Account role"
    },
    "type": {
      "example": "client",
      "collection": false,
      "description": "Account type"
    },
    "uuid": {
      "example": "6d12ec4c-55ec-427d-8ed7-188225e15c57",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
    },
    "last_name": {
      "example": "Thompson",
      "collection": false,
      "description": "Last name"
    },
    "photo_url": {
      "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "collection": false,
      "description": "The photo URL of the client"
    },
    "created_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was updated."
    },
    "external_references": {
      "example": "App\\Http\\Resources\\ExternalReferenceResource",
      "collection": true,
      "description": "The external references that have been added to the client."
    }
  },
  "description": "Document the transaction",
  "completed_at": "2021-01-01 00:00:00",
  "completed_by": {
    "name": {
      "example": "Gareth Thompson",
      "collection": false,
      "description": "Name"
    },
    "role": {
      "example": "client",
      "collection": false,
      "description": "Account role"
    },
    "type": {
      "example": "client",
      "collection": false,
      "description": "Account type"
    },
    "uuid": {
      "example": "add7cf58-d0f6-4b76-9905-4066daa4a85b",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "collection": false,
      "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
    },
    "last_name": {
      "example": "Thompson",
      "collection": false,
      "description": "Last name"
    },
    "photo_url": {
      "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "collection": false,
      "description": "The photo URL of the client"
    },
    "created_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "first_name": {
      "example": "Gareth",
      "collection": false,
      "description": "First name"
    },
    "updated_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was updated."
    },
    "external_references": {
      "example": "App\\Http\\Resources\\ExternalReferenceResource",
      "collection": true,
      "description": "The external references that have been added to the client."
    }
  },
  "is_recurring": true,
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "0f4fd546-d10e-459d-af33-9cc5ec0f2253",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2026-04-08T15:40:47+01:00",
      "updated_at": "2026-04-08T15:40:47+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "taskable_type": "case",
  "workflow_task": {
    "name": {
      "example": "Mortgage Review",
      "collection": false,
      "description": "The name of the task"
    },
    "tags": {
      "example": "App\\Http\\Resources\\TagResource",
      "collection": true,
      "description": "The tags added to the task."
    },
    "uuid": {
      "example": "334c6cf8-0876-4170-9586-0e3f98008056",
      "collection": false,
      "description": "The UUID of the resource."
    },
    "author": {
      "example": "App\\Http\\Resources\\AccountResource",
      "collection": false,
      "description": "The author of the task."
    },
    "groups": {
      "example": "App\\Http\\Resources\\GroupResource",
      "collection": true,
      "description": "The groups that will be added to the task."
    },
    "parent": {
      "example": "App\\Http\\Resources\\Board\\WorkflowBoardTaskResource",
      "collection": false,
      "description": "The parent task."
    },
    "trigger": {
      "example": "App\\Http\\Resources\\Board\\WorkflowBoardTaskResource",
      "collection": false,
      "description": "The task that will trigger this task to be created."
    },
    "position": {
      "example": 2,
      "collection": false,
      "description": "The task position."
    },
    "priority": {
      "example": "high",
      "collection": false,
      "description": "The priority level of the task (e.g p1, p2, p3, p4)"
    },
    "workflow": {
      "example": "App\\Http\\Resources\\Board\\WorkflowResource",
      "collection": false,
      "description": "The workflow that the workflow task belongs to."
    },
    "sub_tasks": {
      "example": "App\\Http\\Resources\\Board\\WorkflowBoardTaskResource",
      "collection": true,
      "description": "The tasks sub tasks."
    },
    "created_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was created."
    },
    "updated_at": {
      "example": "2026-04-08T15:40:47+01:00",
      "collection": false,
      "description": "The timestamp of when the resource was updated."
    },
    "description": {
      "example": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
      "collection": false,
      "description": "The extra description added to a task"
    },
    "task_status": {
      "example": "App\\Http\\Resources\\TaskStatusResource",
      "collection": false,
      "description": "Task status."
    },
    "participants": {
      "example": "App\\Http\\Resources\\AccountResource",
      "collection": true,
      "description": "The participants/assignees of the task."
    },
    "location_uuid": {
      "example": "2e0f1e53-0f34-4f68-b560-45fc261a5514",
      "collection": false,
      "description": "The parent task or workflow trigger task this task is a child of."
    },
    "trigger_tasks": {
      "example": "App\\Http\\Resources\\Board\\WorkflowBoardTaskResource",
      "collection": true,
      "description": "The tasks that will be triggered when this task is completed."
    },
    "is_trigger_task": {
      "example": true,
      "collection": false,
      "description": "Denotes if this is a triggered task."
    },
    "offset_due_at_by": {
      "example": 2,
      "collection": false,
      "description": "How many days from the day the workflow is run should the due at be set by."
    },
    "visible_to_clients": {
      "example": true,
      "collection": false,
      "description": "Indicator for if the task is visible to clients."
    },
    "auto_assign_clients": {
      "example": true,
      "collection": false,
      "description": "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."
    },
    "auto_assign_assigned_adviser": {
      "example": true,
      "collection": false,
      "description": "Denotes if the task will auto-assign the assigned adviser / assigned adviser of the client when it is created."
    },
    "auto_assign_assigned_administrator": {
      "example": true,
      "collection": false,
      "description": "Denotes if the task will auto-assign the administrator of the client when it is created."
    }
  },
  "recurring_last_run": "2026-01-01 00:00:00",
  "recurring_next_run": "2026-01-01 00:00:00",
  "recurring_frequency": "weekly"
}