Create a workflow task

POST /api/v1/workflow/{workflow_uuid}/task

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 \
 -X POST https://api.plannrcrm.com/api/v1/workflow/workflow_uuid/task \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"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":"d37fa658-29bc-4c7a-aa7e-a82f4515d61b","offset_due_at_by":5,"participants":["6ed10851-9062-43d7-bedd-8c118e1b69b0","485b6c7a-12e6-4c43-8ee8-7f45f44b9347"],"parent_uuid":"e3f25650-35bc-4371-8901-b052faf1e2aa","trigger_uuid":"94d7ba9b-d88f-4835-abc3-b482df95ee04","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["807ef226-e34a-4757-a174-99b60af26d21","88f17065-89a1-4c23-9b0c-ba43347a37a8"]}'
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": "d37fa658-29bc-4c7a-aa7e-a82f4515d61b",
  "offset_due_at_by": 5,
  "participants": [
    "6ed10851-9062-43d7-bedd-8c118e1b69b0",
    "485b6c7a-12e6-4c43-8ee8-7f45f44b9347"
  ],
  "parent_uuid": "e3f25650-35bc-4371-8901-b052faf1e2aa",
  "trigger_uuid": "94d7ba9b-d88f-4835-abc3-b482df95ee04",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "807ef226-e34a-4757-a174-99b60af26d21",
    "88f17065-89a1-4c23-9b0c-ba43347a37a8"
  ]
}