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":"00d42e98-fbc3-4410-8e3a-eb8fea24d3fa","offset_due_at_by":5,"participants":["f69640cf-14a2-4ebe-9fe0-31c30671ab2f","c4a68848-0a19-4019-b2d3-f72ae6963b38"],"parent_uuid":"558502e9-7437-47f8-b89e-1d2749d567e6","trigger_uuid":"118c70b2-772e-4377-879a-979b7ad69834","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["b955bbd6-60a3-4529-a7bd-1466339dc66e","be0e8381-bdd8-495f-b156-62cb67d550fb"]}'
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": "00d42e98-fbc3-4410-8e3a-eb8fea24d3fa",
  "offset_due_at_by": 5,
  "participants": [
    "f69640cf-14a2-4ebe-9fe0-31c30671ab2f",
    "c4a68848-0a19-4019-b2d3-f72ae6963b38"
  ],
  "parent_uuid": "558502e9-7437-47f8-b89e-1d2749d567e6",
  "trigger_uuid": "118c70b2-772e-4377-879a-979b7ad69834",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "b955bbd6-60a3-4529-a7bd-1466339dc66e",
    "be0e8381-bdd8-495f-b156-62cb67d550fb"
  ]
}