Update 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.
Value Description low Low medium Medium high High highest Highest Values are
low,medium,high, orhighest. -
The extra description added to a task.
-
The task positioning within the sub tasks or trigger tasks.
-
The number of days the due_at should be set when the workflow has been triggered.
-
The UUID of the task status to use as the default for new tasks created in this workflow.
-
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 PUT 'https://api.plannrcrm.com/api/v1/workflow/6ff8f7f6-1eb3-3525-be4a-3932c805afed/task/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--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.",
"position": 4,
"offset_due_at_by": 5,
"task_status_uuid": "3d3da015-5561-457a-a55f-f6b3310d4e6f",
"participants": [
"6b711ab0-0b43-4530-8e1f-0865abfd3aaa",
"a5b97982-5880-40ed-b229-08eba11c4dd7",
"b3aabfaf-9c0a-455c-829e-97c290cd1fae"
],
"parent_uuid": "0ef2fe91-e340-4a85-922d-c306abcdadde",
"trigger_uuid": "accc9414-65be-43db-84e9-8cffbf16c6b1",
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_assigned_paraplanner": true,
"auto_assign_clients": true,
"groups": [
"86a0ab4a-30a7-44d5-8532-35750cc1a368",
"1696a59c-dd06-4d44-b281-f08a56f290fc",
"26cb6ae8-001a-42fe-846a-95b35709c37a"
]
}'
# 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.",
"position": 4,
"offset_due_at_by": 5,
"task_status_uuid": "3d3da015-5561-457a-a55f-f6b3310d4e6f",
"participants": [
"6b711ab0-0b43-4530-8e1f-0865abfd3aaa",
"a5b97982-5880-40ed-b229-08eba11c4dd7",
"b3aabfaf-9c0a-455c-829e-97c290cd1fae"
],
"parent_uuid": "0ef2fe91-e340-4a85-922d-c306abcdadde",
"trigger_uuid": "accc9414-65be-43db-84e9-8cffbf16c6b1",
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_assigned_paraplanner": true,
"auto_assign_clients": true,
"groups": [
"86a0ab4a-30a7-44d5-8532-35750cc1a368",
"1696a59c-dd06-4d44-b281-f08a56f290fc",
"26cb6ae8-001a-42fe-846a-95b35709c37a"
]
}
{
"message": "The given data was invalid.",
"errors": {
"field": [
"The field is invalid."
]
}
}