Update a workflow task
Headers
-
Content-Type
string -
Accept
string
Path parameters
-
workflow_uuid
string Required -
workflowTask_uuid
integer Required
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 \
--request PUT 'https://api.plannrcrm.com/api/v1/workflow/workflow_uuid/task/workflowTask_uuid' \
--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":"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":"1cbe8256-30c2-4f02-af13-250ac8879e1a","participants":["1a71cb17-bba9-4ca3-9a87-28443ade4036","e4a64563-2b75-4f3e-916f-a1d5f8e48542"],"parent_uuid":"1080ddf7-3896-410d-9d94-a6d2f6eec77e","trigger_uuid":"52e46bbb-1bb7-409b-92a3-c783afbc95d9","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_clients":true,"groups":["53cb426e-5830-4da5-80da-b1adb1a39fc5","36764c16-f7e4-4a73-bb6c-89e1f7314f32"]}'
# 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": "1cbe8256-30c2-4f02-af13-250ac8879e1a",
"participants": [
"1a71cb17-bba9-4ca3-9a87-28443ade4036",
"e4a64563-2b75-4f3e-916f-a1d5f8e48542"
],
"parent_uuid": "1080ddf7-3896-410d-9d94-a6d2f6eec77e",
"trigger_uuid": "52e46bbb-1bb7-409b-92a3-c783afbc95d9",
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"groups": [
"53cb426e-5830-4da5-80da-b1adb1a39fc5",
"36764c16-f7e4-4a73-bb6c-89e1f7314f32"
]
}