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":"e454e7ff-c2a4-4320-936a-37d303e9416a","participants":["c7a4cde9-9879-4f90-a945-5a33b52e9708","20fefbb8-9baf-4590-aed2-fada48b8adb7"],"parent_uuid":"5235a5fc-82a9-4b4e-82db-dad1ef4940ef","trigger_uuid":"cd11279e-cb53-43c8-9bfe-950b7df60969","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["d9859200-9199-4fae-8ab8-673fea886b26","c79307c2-f60c-4615-8356-761aad0dffbe"]}'
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": "e454e7ff-c2a4-4320-936a-37d303e9416a",
  "participants": [
    "c7a4cde9-9879-4f90-a945-5a33b52e9708",
    "20fefbb8-9baf-4590-aed2-fada48b8adb7"
  ],
  "parent_uuid": "5235a5fc-82a9-4b4e-82db-dad1ef4940ef",
  "trigger_uuid": "cd11279e-cb53-43c8-9bfe-950b7df60969",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "d9859200-9199-4fae-8ab8-673fea886b26",
    "c79307c2-f60c-4615-8356-761aad0dffbe"
  ]
}