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":"78860513-e0d9-4114-8b6f-840cebb214b0","participants":["11f80729-c1bb-4831-b667-cc45e409c803","23eeb2ee-171c-436f-97c9-972f8eebf726","ac790d05-386c-4db9-8eb0-0a0f29d32e6c"],"parent_uuid":"739a21c3-7b46-4425-a84b-50b4efc29d0e","trigger_uuid":"cdbe4df6-bd45-4a45-8e9c-8b4a35767892","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["12f5f343-1e18-4cad-b310-e4682e6f0c44","515d1e6e-8526-4c89-a7ca-fcbb21572b39","0659a195-1363-4f7d-87a1-17cc2e71e137"]}'
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": "78860513-e0d9-4114-8b6f-840cebb214b0",
  "participants": [
    "11f80729-c1bb-4831-b667-cc45e409c803",
    "23eeb2ee-171c-436f-97c9-972f8eebf726",
    "ac790d05-386c-4db9-8eb0-0a0f29d32e6c"
  ],
  "parent_uuid": "739a21c3-7b46-4425-a84b-50b4efc29d0e",
  "trigger_uuid": "cdbe4df6-bd45-4a45-8e9c-8b4a35767892",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "12f5f343-1e18-4cad-b310-e4682e6f0c44",
    "515d1e6e-8526-4c89-a7ca-fcbb21572b39",
    "0659a195-1363-4f7d-87a1-17cc2e71e137"
  ]
}