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":"1242be99-3528-450b-8d8a-c5cb54e282b4","offset_due_at_by":5,"participants":["b42c90c0-3fcb-4165-9639-a70a0a24c143","5dab04fb-0ca2-4cb9-aa7e-db7d7a8a3dfe","afb39b83-62c9-452f-8581-198cb2302b41"],"parent_uuid":"d1d6da90-9462-4208-88cf-1855933c7634","trigger_uuid":"4c50639b-d993-4d1b-8043-e135fd37aed0","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["c1a7fa17-815a-475c-8408-597510d441af","cad0badd-b914-46cb-8c6f-31a699b4e6ea","4c6e843b-6f32-4b56-ba67-d6ffe5350a52"]}'
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": "1242be99-3528-450b-8d8a-c5cb54e282b4",
  "offset_due_at_by": 5,
  "participants": [
    "b42c90c0-3fcb-4165-9639-a70a0a24c143",
    "5dab04fb-0ca2-4cb9-aa7e-db7d7a8a3dfe",
    "afb39b83-62c9-452f-8581-198cb2302b41"
  ],
  "parent_uuid": "d1d6da90-9462-4208-88cf-1855933c7634",
  "trigger_uuid": "4c50639b-d993-4d1b-8043-e135fd37aed0",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "c1a7fa17-815a-475c-8408-597510d441af",
    "cad0badd-b914-46cb-8c6f-31a699b4e6ea",
    "4c6e843b-6f32-4b56-ba67-d6ffe5350a52"
  ]
}
Response examples (401) 
{
  "message": "Unauthenticated."
}