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

Path parameters

  • workflow_uuid string Required
  • workflowTask_uuid string Required
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.

    Value Description
    low Low
    medium Medium
    high High
    highest Highest

    Values are low, medium, high, or highest.

  • 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(uuid)]

    Account UUIDs to be assigned to the task.

  • parent_uuid string(uuid)

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

  • trigger_uuid string(uuid)

    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_assigned_paraplanner boolean

    Denotes that when the workflow is run, should we assign the assigned paraplanner 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(uuid)]

    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/6ff8f7f6-1eb3-3525-be4a-3932c805afed/task/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"Mortgage Review","visible_to_clients":true,"priority":"low","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":"4c568ac8-0a36-4505-a0d1-34670b37c76d","participants":["1a454a10-1279-493c-839d-bf28950c5a85","4a423543-a832-4208-ae71-4d3df72fc3f1","23fe64c1-d3f6-48e7-a1d6-2bbb5762280f"],"parent_uuid":"ba395021-acc2-4a32-8307-e92c1f5a8b75","trigger_uuid":"c1134f3a-af78-4170-8c80-0c02a6f6560a","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["341f354d-260e-4024-a007-37d8bf5c046a","427c4b89-fb16-4886-a800-f7fa0bbfdad8","84767fb3-1b1b-4a76-89a8-ee9ac1f8e706"]}'
Request examples 
{
  "name": "Mortgage Review",
  "visible_to_clients": true,
  "priority": "low",
  "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": "4c568ac8-0a36-4505-a0d1-34670b37c76d",
  "participants": [
    "1a454a10-1279-493c-839d-bf28950c5a85",
    "4a423543-a832-4208-ae71-4d3df72fc3f1",
    "23fe64c1-d3f6-48e7-a1d6-2bbb5762280f"
  ],
  "parent_uuid": "ba395021-acc2-4a32-8307-e92c1f5a8b75",
  "trigger_uuid": "c1134f3a-af78-4170-8c80-0c02a6f6560a",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "341f354d-260e-4024-a007-37d8bf5c046a",
    "427c4b89-fb16-4886-a800-f7fa0bbfdad8",
    "84767fb3-1b1b-4a76-89a8-ee9ac1f8e706"
  ]
}