Update a workflow task

PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
Personal access token & O auth2
application/json

Body

  • name string

    The name of the task.

  • visible_to_clients boolean

    Denotes if the task is visible to clients.

  • priority string

    The priority of the workflow task. Possible values are: high, low and null.

  • description string

    The extra description added to a task.

  • position integer

    The task positioning within the sub tasks or trigger tasks.

  • offset_due_at_by integer

    The number of days the due_at should be set when the workflow has been triggered.

  • task_status_uuid string

    The UUID of the task status to use as the default for new tasks created in this workflow.

  • participants array[string]

    Account UUIDs to be assigned to the task.

  • parent_uuid string

    The parent task. Apply this if you want the task to be one of a tasks sub-tasks.

  • trigger_uuid string

    The task that will trigger this task to be created.

  • auto_assign_assigned_adviser boolean

    Denotes that when the workflow is run, should we assign the assigned adviser of the client as a participant of the task. Only works when a workflow is run on a client.

  • auto_assign_assigned_administrator boolean

    Denotes that when the workflow is run, should we assign the administrator of the client as a participant of the task. Only works when a workflow is run on a client.

  • auto_assign_clients boolean

    Denotes that when the workflow is run, should we assign the client as a participant of the task.

  • groups array[string]

    UUIDs of groups that will be assigned when the task is created.
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/workflow/workflow_uuid/task/workflowTask_uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"name":"Mortgage Review","visible_to_clients":true,"priority":"high","description":"We need to run through a mortgage review with Gareth, as he can probably find a better deal.","position":4,"offset_due_at_by":5,"task_status_uuid":"db337d5a-1557-4a9e-861c-6c39e170b2e6","participants":["f718c40d-511f-49da-8144-0ca8f0734e99","0d4fd9aa-eacf-4819-a332-e761dab9e35e"],"parent_uuid":"1b9b0e64-a259-4d99-839e-bfc8eef8149c","trigger_uuid":"a35bc8b1-14f7-4439-b896-ec50631bfbba","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["00b8028a-0a82-48f5-b249-0f39b3e1a246","2f0128ed-b8c8-43bf-bbef-b8da98a56228"]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": "Mortgage Review",
  "visible_to_clients": true,
  "priority": "high",
  "description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
  "position": 4,
  "offset_due_at_by": 5,
  "task_status_uuid": "db337d5a-1557-4a9e-861c-6c39e170b2e6",
  "participants": [
    "f718c40d-511f-49da-8144-0ca8f0734e99",
    "0d4fd9aa-eacf-4819-a332-e761dab9e35e"
  ],
  "parent_uuid": "1b9b0e64-a259-4d99-839e-bfc8eef8149c",
  "trigger_uuid": "a35bc8b1-14f7-4439-b896-ec50631bfbba",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "00b8028a-0a82-48f5-b249-0f39b3e1a246",
    "2f0128ed-b8c8-43bf-bbef-b8da98a56228"
  ]
}