Create a workflow task

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

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":"d7e8424e-7346-4b31-94d2-fbdeac2990bb","offset_due_at_by":5,"participants":["7cb20de6-33e4-4942-be4f-3a6a3651fc90","a2e011b2-df5b-4679-8dcd-74b6acea7bc4"],"parent_uuid":"38c3c275-070e-4312-b338-452385f4b77d","trigger_uuid":"848a1019-4dd6-4f4c-9ada-25b8762126a9","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["7ae2815b-c25b-45a1-a8b8-637f94d2f760","4021e8c7-2b30-410d-a1fe-9a2d513df5c6"]}'
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": "d7e8424e-7346-4b31-94d2-fbdeac2990bb",
  "offset_due_at_by": 5,
  "participants": [
    "7cb20de6-33e4-4942-be4f-3a6a3651fc90",
    "a2e011b2-df5b-4679-8dcd-74b6acea7bc4"
  ],
  "parent_uuid": "38c3c275-070e-4312-b338-452385f4b77d",
  "trigger_uuid": "848a1019-4dd6-4f4c-9ada-25b8762126a9",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "7ae2815b-c25b-45a1-a8b8-637f94d2f760",
    "4021e8c7-2b30-410d-a1fe-9a2d513df5c6"
  ]
}