PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
Personal access token & O auth2

Path parameters

  • workflow_uuid string Required
  • workflowTask_uuid string Required
application/json

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.

    Value Description
    low Low
    medium Medium
    high High
    highest Highest

    Values are low, medium, high, or highest.

  • 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(uuid)]

    Account UUIDs to be assigned to the task.

  • parent_uuid string(uuid)

    The parent task. Apply this if you want the task to be one of a tasks sub-tasks.

  • trigger_uuid string(uuid)

    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.

  • auto_assign_assigned_administrator boolean

    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_assigned_paraplanner boolean

    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.

  • 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(uuid)]

    UUIDs of groups that will be assigned when the task is created.
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid} 
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" \
 --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":"4be9cfdb-2771-4922-8b5e-4ae804c9ae1c","participants":["abe0b1be-ba58-4993-9eeb-2d623d39b4b8","67fede64-10e9-4c30-8de1-55185fe911da","8f04b64c-15ac-42d2-bbae-eb578ba39b0c"],"parent_uuid":"5ff9d6fe-bbf3-47c8-87ac-f7e4a94ade33","trigger_uuid":"991a78d8-4eca-4faa-aa08-459e625c6cc7","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["81e83b8c-8008-49b2-bec6-a7de9d693d10","018d1dad-8543-4ec1-aad7-ae94eae176a2","adc67a98-bb8f-4ba3-9c8a-78daee130af9"]}'
Request examples 
{
  "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": "4be9cfdb-2771-4922-8b5e-4ae804c9ae1c",
  "participants": [
    "abe0b1be-ba58-4993-9eeb-2d623d39b4b8",
    "67fede64-10e9-4c30-8de1-55185fe911da",
    "8f04b64c-15ac-42d2-bbae-eb578ba39b0c"
  ],
  "parent_uuid": "5ff9d6fe-bbf3-47c8-87ac-f7e4a94ade33",
  "trigger_uuid": "991a78d8-4eca-4faa-aa08-459e625c6cc7",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "81e83b8c-8008-49b2-bec6-a7de9d693d10",
    "018d1dad-8543-4ec1-aad7-ae94eae176a2",
    "adc67a98-bb8f-4ba3-9c8a-78daee130af9"
  ]
}