Update a workflow task

PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
Personal access token & OAuth2
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":"cb0b17a8-41c9-4191-a458-2036ea2337f1","participants":["c68d99b0-1be3-4168-8901-ba2079b7adfb","ad5ea5e8-0345-43fc-9182-ed63eca5691c"],"parent_uuid":"f776b1a8-ac3e-4b4f-af98-2d87f9f6ca24","trigger_uuid":"1c5f89e5-43b4-4236-8906-cbced77586e7","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["ef6e30bd-856d-45ed-b297-55b359e79a61","ca89d298-f5ed-4624-9190-a98ee6b666fc"]}'
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": "cb0b17a8-41c9-4191-a458-2036ea2337f1",
  "participants": [
    "c68d99b0-1be3-4168-8901-ba2079b7adfb",
    "ad5ea5e8-0345-43fc-9182-ed63eca5691c"
  ],
  "parent_uuid": "f776b1a8-ac3e-4b4f-af98-2d87f9f6ca24",
  "trigger_uuid": "1c5f89e5-43b4-4236-8906-cbced77586e7",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "ef6e30bd-856d-45ed-b297-55b359e79a61",
    "ca89d298-f5ed-4624-9190-a98ee6b666fc"
  ]
}