Create a workflow task

POST /api/v1/workflow/{workflow_uuid}/task
Personal access token & O auth2

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 \
 --request POST 'https://api.plannrcrm.com/api/v1/workflow/workflow_uuid/task' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: 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.","task_status_uuid":"c7143b2c-fe42-416d-ad73-0af8e09b3750","offset_due_at_by":5,"participants":["3636a7e3-5fcb-4c9c-b317-1f0428a22cca","e95e2af8-5700-486b-8e1a-d8ad9bc77b11"],"parent_uuid":"4e1b0b31-8f67-4baa-9545-206ec9fe822b","trigger_uuid":"75d34ade-1367-4f09-be4c-0a79e7ea9cc4","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["0569a705-1d23-42ab-bf36-8f927f6deb57","78b8d47b-88d6-4f55-9467-dbb4eb741105"]}'
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": "c7143b2c-fe42-416d-ad73-0af8e09b3750",
  "offset_due_at_by": 5,
  "participants": [
    "3636a7e3-5fcb-4c9c-b317-1f0428a22cca",
    "e95e2af8-5700-486b-8e1a-d8ad9bc77b11"
  ],
  "parent_uuid": "4e1b0b31-8f67-4baa-9545-206ec9fe822b",
  "trigger_uuid": "75d34ade-1367-4f09-be4c-0a79e7ea9cc4",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "0569a705-1d23-42ab-bf36-8f927f6deb57",
    "78b8d47b-88d6-4f55-9467-dbb4eb741105"
  ]
}