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":"8289811d-ec6f-4a9f-8e8b-38fe8361e0b2","participants":["64010cd5-5996-49ba-af71-f9547f579eca","3542ba86-6f67-43ed-ba14-1bc743423b71","e864cc49-c2e7-4c3f-a880-3cfe15c5a227"],"parent_uuid":"5f0a3967-f939-46e1-b649-35ec6a0d592d","trigger_uuid":"d2029dc5-0af4-4f3f-a1cb-d1729aeec69a","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["deb2a3c7-b0f3-4c3a-bcde-020626ef45f2","d18d7b52-71ee-4e65-870b-9f652bec1be2","952ea3c6-478d-4643-b9b4-c32323eac722"]}'
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": "8289811d-ec6f-4a9f-8e8b-38fe8361e0b2",
  "participants": [
    "64010cd5-5996-49ba-af71-f9547f579eca",
    "3542ba86-6f67-43ed-ba14-1bc743423b71",
    "e864cc49-c2e7-4c3f-a880-3cfe15c5a227"
  ],
  "parent_uuid": "5f0a3967-f939-46e1-b649-35ec6a0d592d",
  "trigger_uuid": "d2029dc5-0af4-4f3f-a1cb-d1729aeec69a",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "deb2a3c7-b0f3-4c3a-bcde-020626ef45f2",
    "d18d7b52-71ee-4e65-870b-9f652bec1be2",
    "952ea3c6-478d-4643-b9b4-c32323eac722"
  ]
}