Run a workflow

POST /api/v1/workflow/{workflow_uuid}/run
Personal access token & OAuth2

Headers

Path parameters

application/json

Body Required

  • model_type string Required

    The type of model to trigger a workflow on. Valid types: client, case

  • model_uuid string Required

    The uuid of the model to run the workflow on.
POST /api/v1/workflow/{workflow_uuid}/run 
curl \
 --request POST https://api.plannrcrm.com/api/v1/workflow/workflow_uuid/run \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"model_type":"client","model_uuid":"string"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "model_type": "client",
  "model_uuid": "string"
}