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

Path parameters

  • workflow_uuid string Required
application/json

Body

  • name string Required

    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.

  • task_status_uuid string

    The UUID of the task status to use as the default for new tasks created in this workflow.

  • offset_due_at_by integer

    The number of days the due_at should be set when the workflow has been triggered.

  • 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.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/workflow/{workflow_uuid}/task 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/workflow/6ff8f7f6-1eb3-3525-be4a-3932c805afed/task' \
 --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.","task_status_uuid":"42dfa8ab-c218-4f83-a979-1896a0b54ede","offset_due_at_by":5,"participants":["9811523a-b5a4-4ef4-98fb-298da01f992e","4202475b-37b9-4ee9-a3aa-0cb785294611","cb8ea8ed-491a-4f5c-a08c-95a381c1f151"],"parent_uuid":"c2756b7c-2021-46cf-916b-5e944cefaaf1","trigger_uuid":"96c6ca3f-5a9b-406a-9dba-c3aac392aa56","auto_assign_assigned_adviser":true,"auto_assign_assigned_administrator":true,"auto_assign_assigned_paraplanner":true,"auto_assign_clients":true,"groups":["6f853718-fd3c-44cd-abad-1fb4365f1d72","799108be-d5cf-49aa-bede-7580619029d6","588b8fee-5191-4841-a99b-fee73dc8c6a5"]}'
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.",
  "task_status_uuid": "42dfa8ab-c218-4f83-a979-1896a0b54ede",
  "offset_due_at_by": 5,
  "participants": [
    "9811523a-b5a4-4ef4-98fb-298da01f992e",
    "4202475b-37b9-4ee9-a3aa-0cb785294611",
    "cb8ea8ed-491a-4f5c-a08c-95a381c1f151"
  ],
  "parent_uuid": "c2756b7c-2021-46cf-916b-5e944cefaaf1",
  "trigger_uuid": "96c6ca3f-5a9b-406a-9dba-c3aac392aa56",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "6f853718-fd3c-44cd-abad-1fb4365f1d72",
    "799108be-d5cf-49aa-bede-7580619029d6",
    "588b8fee-5191-4841-a99b-fee73dc8c6a5"
  ]
}
Response examples (401) 
{
  "message": "Unauthenticated."
}