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":"2233c730-2392-4ac3-a570-999344519a33","offset_due_at_by":5,"participants":["a74bfd42-edcb-4343-bf20-7dc67c2305ad","90d44264-1326-4cb0-a861-09a121eaed06"],"parent_uuid":"3e0586b8-141f-4de0-ac16-2908c314338c","trigger_uuid":"b0170140-b273-4fb0-9677-bf3077a57946","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["207b5d39-67b1-480b-b65f-a3a463f5a080","2f591568-ddc1-422d-9c4e-ba9c8a3b3a92"]}'
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": "2233c730-2392-4ac3-a570-999344519a33",
  "offset_due_at_by": 5,
  "participants": [
    "a74bfd42-edcb-4343-bf20-7dc67c2305ad",
    "90d44264-1326-4cb0-a861-09a121eaed06"
  ],
  "parent_uuid": "3e0586b8-141f-4de0-ac16-2908c314338c",
  "trigger_uuid": "b0170140-b273-4fb0-9677-bf3077a57946",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "207b5d39-67b1-480b-b65f-a3a463f5a080",
    "2f591568-ddc1-422d-9c4e-ba9c8a3b3a92"
  ]
}