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":"e74911d0-b735-402e-8cb9-6bf90d0511f5","offset_due_at_by":5,"participants":["8fd7a343-f8f9-4daf-a4f4-c3b748a01434","4b66f4be-234d-4a0e-977e-88ff1fdd0599"],"parent_uuid":"5fcd1287-d673-49a1-b1e5-0419059c6c56","trigger_uuid":"58fcd00d-a034-41bf-9e2e-1edf1a812456","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["a0126884-0d51-4321-9393-d7c874fb53c3","b9e20b80-e06a-4a30-95fd-a7fe39bcf0a8"]}'
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": "e74911d0-b735-402e-8cb9-6bf90d0511f5",
  "offset_due_at_by": 5,
  "participants": [
    "8fd7a343-f8f9-4daf-a4f4-c3b748a01434",
    "4b66f4be-234d-4a0e-977e-88ff1fdd0599"
  ],
  "parent_uuid": "5fcd1287-d673-49a1-b1e5-0419059c6c56",
  "trigger_uuid": "58fcd00d-a034-41bf-9e2e-1edf1a812456",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_clients": true,
  "groups": [
    "a0126884-0d51-4321-9393-d7c874fb53c3",
    "b9e20b80-e06a-4a30-95fd-a7fe39bcf0a8"
  ]
}