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

Path parameters

  • workflow_uuid string Required
application/json

Body

  • model_type string Required

    The type of model to trigger a workflow on.

    Value Description
    client Client
    case Case

    Values are client or case.

  • model_uuid string(uuid) Required

    The uuid of the model to trigger a workflow on.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/workflow/{workflow_uuid}/run 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/workflow/6ff8f7f6-1eb3-3525-be4a-3932c805afed/run' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"model_type":"client","model_uuid":"c3d14ebe-e48b-43f2-9a8c-4f696565ad80"}'
Request examples 
{
  "model_type": "client",
  "model_uuid": "c3d14ebe-e48b-43f2-9a8c-4f696565ad80"
}
Response examples (401) 
{
  "message": "Unauthenticated."
}