Create a workflow task

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":"6be995fa-45c2-4742-ae92-e02ed8b1bfa5","offset_due_at_by":5,"participants":["96be6f0a-f3f3-4e44-b76c-ccaa2b0e0acc","a5b39950-5c83-4de7-a9a9-68e7fbd2957f"],"parent_uuid":"861494d4-e9de-4bee-8038-88a854cf5e89","trigger_uuid":"5a623a0c-665c-4928-b601-427307beb8ed","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["fb9864eb-725f-4662-98b6-a90d7fe712a7","c09b8b63-6ce4-4a5d-bab5-fa1e179a9028"]}'
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": "6be995fa-45c2-4742-ae92-e02ed8b1bfa5",
  "offset_due_at_by": 5,
  "participants": [
    "96be6f0a-f3f3-4e44-b76c-ccaa2b0e0acc",
    "a5b39950-5c83-4de7-a9a9-68e7fbd2957f"
  ],
  "parent_uuid": "861494d4-e9de-4bee-8038-88a854cf5e89",
  "trigger_uuid": "5a623a0c-665c-4928-b601-427307beb8ed",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "fb9864eb-725f-4662-98b6-a90d7fe712a7",
    "c09b8b63-6ce4-4a5d-bab5-fa1e179a9028"
  ]
}
Response examples (401) 
{
  "message": "Unauthenticated."
}