Create a workflow task Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
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 Required

      A human-readable description of the error.
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
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": "56bd76d1-6063-4d79-98e2-bd3de7d663c0",
  "offset_due_at_by": 5,
  "participants": [
    "cdf91eaa-4e5a-4506-ab48-0368639b566e",
    "530c1bec-d497-46f0-b376-177655659f83",
    "33c18cf2-8caf-4930-ab9c-ec3ff120ac6f"
  ],
  "parent_uuid": "5c4c96c4-f459-4926-bdd1-51fb45541498",
  "trigger_uuid": "7c40a8ee-5fbc-4a5b-aa03-850617d36dd3",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "8f77c42d-a839-4d2a-944b-e6ae22b23fab",
    "8436771a-0835-4d49-9be0-39c69789d9cb",
    "6bdf3139-eabd-4160-bb97-a28e8d4c875e"
  ]
}'
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": "56bd76d1-6063-4d79-98e2-bd3de7d663c0",
  "offset_due_at_by": 5,
  "participants": [
    "cdf91eaa-4e5a-4506-ab48-0368639b566e",
    "530c1bec-d497-46f0-b376-177655659f83",
    "33c18cf2-8caf-4930-ab9c-ec3ff120ac6f"
  ],
  "parent_uuid": "5c4c96c4-f459-4926-bdd1-51fb45541498",
  "trigger_uuid": "7c40a8ee-5fbc-4a5b-aa03-850617d36dd3",
  "auto_assign_assigned_adviser": true,
  "auto_assign_assigned_administrator": true,
  "auto_assign_assigned_paraplanner": true,
  "auto_assign_clients": true,
  "groups": [
    "8f77c42d-a839-4d2a-944b-e6ae22b23fab",
    "8436771a-0835-4d49-9be0-39c69789d9cb",
    "6bdf3139-eabd-4160-bb97-a28e8d4c875e"
  ]
}
Response examples (401) 
{
  "message": "Unauthenticated."
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}