Create a workflow task Run in API Explorer

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

Path parameters

  • workflow_uuid string Required
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_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]

    UUIDs of groups that will be assigned when the task is created.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/workflow/{workflow_uuid}/task 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/workflow/6ff8f7f6-1eb3-3525-be4a-3932c805afed/task' \
 --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.","task_status_uuid":"03a63d1d-3b2d-4571-b0bd-16fc8775bfad","offset_due_at_by":5,"participants":["3dfd3ec0-69b8-44fe-8ce3-6f7874f476a7","5d0d6279-3a38-4e74-9ddc-27a084bb0672"],"parent_uuid":"1ee87e89-f130-4bf6-8780-77057c5ee4c0","trigger_uuid":"eb3fef87-9cf1-4f18-886d-f657526214b9","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["9e1bc0dc-ab20-4e48-a2dc-067383f4d35a","40b83a32-b8f8-4d02-9ae0-5aa5bfbcd60a"]}'
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.",
  "task_status_uuid": "03a63d1d-3b2d-4571-b0bd-16fc8775bfad",
  "offset_due_at_by": 5,
  "participants": [
    "3dfd3ec0-69b8-44fe-8ce3-6f7874f476a7",
    "5d0d6279-3a38-4e74-9ddc-27a084bb0672"
  ],
  "parent_uuid": "1ee87e89-f130-4bf6-8780-77057c5ee4c0",
  "trigger_uuid": "eb3fef87-9cf1-4f18-886d-f657526214b9",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "9e1bc0dc-ab20-4e48-a2dc-067383f4d35a",
    "40b83a32-b8f8-4d02-9ae0-5aa5bfbcd60a"
  ]
}
Response examples (401) 
{
  "message": "Unauthenticated."
}