Update a workflow task
Headers
-
Content-Type string
-
Accept string
Body
-
name string
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.
-
position integer
The task positioning within the sub tasks or trigger tasks.
-
offset_due_at_by integer
The number of days the due_at should be set when the workflow has been triggered.
-
task_status_uuid string
The UUID of the task status to use as the default for new tasks created in this workflow.
-
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 PUT https://api.plannrcrm.com/api/v1/workflow/workflow_uuid/task/workflowTask_uuid \
-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":"high","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":"dca515eb-1849-44ff-9314-24ed252b4a0d","participants":["f19cc3d0-fad5-41f8-b0a2-76409af00ceb","945f7909-4766-4c07-81bd-f38a05c77dc8"],"parent_uuid":"4637c57a-969f-4b2d-a0de-49403450b518","trigger_uuid":"ded8b085-6870-480f-9bf5-7de2e7326770","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["1d3854e2-696d-4459-8b0b-2bab19a05ecb","f254c01a-1c6f-41ca-9d6e-0aafdb7cfd6c"]}'
# 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": "high",
"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": "dca515eb-1849-44ff-9314-24ed252b4a0d",
"participants": [
"f19cc3d0-fad5-41f8-b0a2-76409af00ceb",
"945f7909-4766-4c07-81bd-f38a05c77dc8"
],
"parent_uuid": "4637c57a-969f-4b2d-a0de-49403450b518",
"trigger_uuid": "ded8b085-6870-480f-9bf5-7de2e7326770",
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"groups": [
"1d3854e2-696d-4459-8b0b-2bab19a05ecb",
"f254c01a-1c6f-41ca-9d6e-0aafdb7cfd6c"
]
}