Create a workflow task Run in API Explorer
Body
-
The name of the task.
-
Denotes if the task is visible to clients.
-
The priority of the workflow task. Possible values are: high, low and null
-
The extra description added to a task.
-
The UUID of the task status to use as the default for new tasks created in this workflow.
-
The number of days the due_at should be set when the workflow has been triggered.
-
Account UUIDs to be assigned to the task.
-
The parent task. Apply this if you want the task to be one of a tasks sub-tasks.
-
The task that will trigger this task to be created.
-
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.
-
Denotes that when the workflow is run, should we assign the assigned paraplanner 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 client as a participant of the task.
-
UUIDs of groups that will be assigned when the task is created.
curl \
--request POST 'https://api.plannrcrm.com/api/v1/workflow/6ff8f7f6-1eb3-3525-be4a-3932c805afed/task' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--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": "5e1dd502-bd18-42b0-bdd5-623fb8a657dc",
"offset_due_at_by": 5,
"participants": [
"21dc1963-5764-4fec-b5a2-858b79246d86",
"ae74a591-dde7-4f4f-9698-3479310c8a0a",
"5f5d61e0-3a40-4b78-9058-373d9d156449"
],
"parent_uuid": "05f94aad-e68f-4a5c-ac96-a932f3166e69",
"trigger_uuid": "f1dc83d4-e0bb-421f-9447-aa1ad5e3192a",
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_assigned_paraplanner": true,
"auto_assign_clients": true,
"groups": [
"1db6dba9-6970-47aa-bc27-9f53d6772fc0",
"2feebddb-e5e3-4604-849c-22c1c4af2fe6",
"4ab75fb5-7e8f-40a3-994c-c1d6dd64a099"
]
}'
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# 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": "5e1dd502-bd18-42b0-bdd5-623fb8a657dc",
"offset_due_at_by": 5,
"participants": [
"21dc1963-5764-4fec-b5a2-858b79246d86",
"ae74a591-dde7-4f4f-9698-3479310c8a0a",
"5f5d61e0-3a40-4b78-9058-373d9d156449"
],
"parent_uuid": "05f94aad-e68f-4a5c-ac96-a932f3166e69",
"trigger_uuid": "f1dc83d4-e0bb-421f-9447-aa1ad5e3192a",
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_assigned_paraplanner": true,
"auto_assign_clients": true,
"groups": [
"1db6dba9-6970-47aa-bc27-9f53d6772fc0",
"2feebddb-e5e3-4604-849c-22c1c4af2fe6",
"4ab75fb5-7e8f-40a3-994c-c1d6dd64a099"
]
}
{
"message": "Unauthenticated."
}
{
"message": "The given data was invalid.",
"errors": {
"field": [
"The field is invalid."
]
}
}