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

Path parameters

  • workflow_uuid string Required
application/json

Body

  • 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(uuid)]

    Account UUIDs to be assigned to the task.

  • parent_uuid string(uuid)

    The parent task. Apply this if you want the task to be one of a tasks sub-tasks.

  • trigger_uuid string(uuid)

    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(uuid)]

    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":"a3ea1238-1b2d-4639-af32-f557017efa93","offset_due_at_by":5,"participants":["758426d7-e9f4-4360-b365-b04e64131ede","d6988a15-0003-435e-b482-deb3411bca0b","65910357-9eec-43af-9f04-0a441b14657f"],"parent_uuid":"95fe070d-df4b-4de2-8c7d-d3c54424e018","trigger_uuid":"c7559793-a89b-4f29-a1bb-7cfb9a355c5b","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["ba5fb38a-c4ce-412a-84cb-46f9b7a934bf","02da9a86-c838-4cc8-8e4d-14311d929df5","eb443ea7-d3a7-4969-bdf9-e0cd1fa92226"]}'
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": "a3ea1238-1b2d-4639-af32-f557017efa93",
  "offset_due_at_by": 5,
  "participants": [
    "758426d7-e9f4-4360-b365-b04e64131ede",
    "d6988a15-0003-435e-b482-deb3411bca0b",
    "65910357-9eec-43af-9f04-0a441b14657f"
  ],
  "parent_uuid": "95fe070d-df4b-4de2-8c7d-d3c54424e018",
  "trigger_uuid": "c7559793-a89b-4f29-a1bb-7cfb9a355c5b",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "ba5fb38a-c4ce-412a-84cb-46f9b7a934bf",
    "02da9a86-c838-4cc8-8e4d-14311d929df5",
    "eb443ea7-d3a7-4969-bdf9-e0cd1fa92226"
  ]
}
Response examples (401) 
{
  "message": "Unauthenticated."
}