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":"a5d7d5a5-62ce-424e-9939-804e434de81a","participants":["af85f89a-f37f-4d07-aadb-d709a3607e92","57dbe049-1309-4db1-9e28-08ce11a6be42","7c42efe4-4019-4512-bf38-f842629d2646"],"parent_uuid":"be0eeffe-b411-4c4c-b978-f093634488f3","trigger_uuid":"d3b88561-b566-4b98-a578-977f0b7b25ad","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["64c352a4-a6b8-4453-838b-79e8f2347747","f41801d7-53cd-489c-82f2-4820b53fc23e","a8e2c171-961e-4941-9c5a-338ffc1bd120"]}'
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": "a5d7d5a5-62ce-424e-9939-804e434de81a",
  "participants": [
    "af85f89a-f37f-4d07-aadb-d709a3607e92",
    "57dbe049-1309-4db1-9e28-08ce11a6be42",
    "7c42efe4-4019-4512-bf38-f842629d2646"
  ],
  "parent_uuid": "be0eeffe-b411-4c4c-b978-f093634488f3",
  "trigger_uuid": "d3b88561-b566-4b98-a578-977f0b7b25ad",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "64c352a4-a6b8-4453-838b-79e8f2347747",
    "f41801d7-53cd-489c-82f2-4820b53fc23e",
    "a8e2c171-961e-4941-9c5a-338ffc1bd120"
  ]
}