Create a workflow task
Headers
-
Content-Type string
-
Accept string
Body 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.
-
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.
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":"cc9085e6-c68a-43e3-b5b7-0e0bbc634389","offset_due_at_by":5,"participants":["b98add02-07e1-4eca-8197-17f170da721c","c65477a1-22b5-40e1-ac2c-d6a36c6d1c86"],"parent_uuid":"a156a30f-d308-43b9-b3b2-1e7cb5991d32","trigger_uuid":"bd17bd98-b045-4236-843f-5383bef91486","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["60d1fd47-0385-4482-a32d-0a0164d8f7a9","28f8036b-0072-4139-a9bc-cace20e1f388"]}'
# 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": "cc9085e6-c68a-43e3-b5b7-0e0bbc634389",
"offset_due_at_by": 5,
"participants": [
"b98add02-07e1-4eca-8197-17f170da721c",
"c65477a1-22b5-40e1-ac2c-d6a36c6d1c86"
],
"parent_uuid": "a156a30f-d308-43b9-b3b2-1e7cb5991d32",
"trigger_uuid": "bd17bd98-b045-4236-843f-5383bef91486",
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"groups": [
"60d1fd47-0385-4482-a32d-0a0164d8f7a9",
"28f8036b-0072-4139-a9bc-cace20e1f388"
]
}