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":"5830a4c5-5aaf-4e56-9953-72673382b21e","participants":["ee6a4528-a237-45ef-9777-6c9475c73402","8488b729-b495-4b94-8ccb-9f1056d6bc58","87995206-86b8-4551-8bc0-da686551816a"],"parent_uuid":"1ea5cd4c-6791-490e-b6cc-1ce90ff51a1d","trigger_uuid":"6c007607-9ee7-4e5a-8191-c590ff389824","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["faa213a7-b781-43fd-912c-37bda419b7dd","2a626beb-27c9-4146-bc7f-aa6ec6b42b56","1e23c8f0-028b-4426-be4c-53b5a7377887"]}'
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": "5830a4c5-5aaf-4e56-9953-72673382b21e",
  "participants": [
    "ee6a4528-a237-45ef-9777-6c9475c73402",
    "8488b729-b495-4b94-8ccb-9f1056d6bc58",
    "87995206-86b8-4551-8bc0-da686551816a"
  ],
  "parent_uuid": "1ea5cd4c-6791-490e-b6cc-1ce90ff51a1d",
  "trigger_uuid": "6c007607-9ee7-4e5a-8191-c590ff389824",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "faa213a7-b781-43fd-912c-37bda419b7dd",
    "2a626beb-27c9-4146-bc7f-aa6ec6b42b56",
    "1e23c8f0-028b-4426-be4c-53b5a7377887"
  ]
}