Create a workflow task

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

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":"0e66f16b-9ac5-4f12-9cef-c5474b620bef","offset_due_at_by":5,"participants":["f32a4558-d234-4186-8e32-3b8baea1cfd2","5a8f996a-fa74-46cc-9525-122d18a7f00a"],"parent_uuid":"db5a5845-9827-474d-9955-2dcace3ed578","trigger_uuid":"47197680-68a2-4d91-a89e-d80559f035b8","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["6f2722a5-8cde-4e2b-9d73-b76161838930","3a6a27ff-4973-46c0-aab9-10bc87567ff6"]}'
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": "0e66f16b-9ac5-4f12-9cef-c5474b620bef",
  "offset_due_at_by": 5,
  "participants": [
    "f32a4558-d234-4186-8e32-3b8baea1cfd2",
    "5a8f996a-fa74-46cc-9525-122d18a7f00a"
  ],
  "parent_uuid": "db5a5845-9827-474d-9955-2dcace3ed578",
  "trigger_uuid": "47197680-68a2-4d91-a89e-d80559f035b8",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "6f2722a5-8cde-4e2b-9d73-b76161838930",
    "3a6a27ff-4973-46c0-aab9-10bc87567ff6"
  ]
}