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":"141495f3-e151-43ca-b8a0-0a81f672a47d","participants":["f5db102c-2410-4f83-8fe9-4e158a856497","a770f897-a5ff-482f-b7ae-088e3ff9d423","504f7253-cb2b-4cd4-8597-e4494720a43e"],"parent_uuid":"1d7fd8c7-6f7e-4242-b69a-2199cc863fc7","trigger_uuid":"5b47f50b-557e-4916-a7cf-aa8672670757","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["379efc6d-0df2-4cd2-9375-803d334f627c","cb4985fa-7b73-418c-a133-bd435f7dc77a","bcf679f7-474d-4fa4-b824-c4b9a849b5bb"]}'
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": "141495f3-e151-43ca-b8a0-0a81f672a47d",
  "participants": [
    "f5db102c-2410-4f83-8fe9-4e158a856497",
    "a770f897-a5ff-482f-b7ae-088e3ff9d423",
    "504f7253-cb2b-4cd4-8597-e4494720a43e"
  ],
  "parent_uuid": "1d7fd8c7-6f7e-4242-b69a-2199cc863fc7",
  "trigger_uuid": "5b47f50b-557e-4916-a7cf-aa8672670757",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "379efc6d-0df2-4cd2-9375-803d334f627c",
    "cb4985fa-7b73-418c-a133-bd435f7dc77a",
    "bcf679f7-474d-4fa4-b824-c4b9a849b5bb"
  ]
}