Create a workflow task

POST /api/v1/workflow/{workflow_uuid}/task

Headers

Path parameters

application/json

Body Required

  • name string Required

    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

  • description string

    The extra description added to a task.

  • task_status_uuid string

    The UUID of the task status to use as the default for new tasks created in this workflow.

  • offset_due_at_by integer

    The number of days the due_at should be set when the workflow has been triggered.

  • participants array[string]

    Account UUIDs to be assigned to the task.

  • parent_uuid string

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

  • trigger_uuid string

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

    Denotes that when the workflow is run, should we assign the client as a participant of the task.

  • groups array[string]

    UUIDs of groups that will be assigned when the task is created.
POST /api/v1/workflow/{workflow_uuid}/task 
curl \
 -X POST https://api.plannrcrm.com/api/v1/workflow/workflow_uuid/task \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"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.","task_status_uuid":"2bac0144-a6e0-44b5-8a01-7bb6c95ed0b3","offset_due_at_by":5,"participants":["15de9dc7-1757-4359-943f-a73a4c56da0b","fb28673c-7480-4433-bb8e-b1811f8bacbd"],"parent_uuid":"4bc89940-e91f-41ff-b2ed-eee45de7dd47","trigger_uuid":"9fb010bb-6b9d-4d42-833a-bb9a8c85b614","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["c1fd58fe-fa96-44aa-bc33-974670d8068e","47643976-3839-4e24-ac7c-9c8a2296c8ed"]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "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.",
  "task_status_uuid": "2bac0144-a6e0-44b5-8a01-7bb6c95ed0b3",
  "offset_due_at_by": 5,
  "participants": [
    "15de9dc7-1757-4359-943f-a73a4c56da0b",
    "fb28673c-7480-4433-bb8e-b1811f8bacbd"
  ],
  "parent_uuid": "4bc89940-e91f-41ff-b2ed-eee45de7dd47",
  "trigger_uuid": "9fb010bb-6b9d-4d42-833a-bb9a8c85b614",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "c1fd58fe-fa96-44aa-bc33-974670d8068e",
    "47643976-3839-4e24-ac7c-9c8a2296c8ed"
  ]
}