Run workflow

POST /wf/run_workflow

Run workflow

Body object

Body of the POST request

One of:
FileUploadBase64 object FileUploadURL object

Responses

  • 200

    Workflow response

    Hide response attributes Show response attributes object
  • 400

    Workflow failure

    Hide response attributes Show response attributes object
    • status string

      Outcome of the workflow

    • message string

      Error message for the workflow
  • 401

    Permission denied

    Hide response attribute Show response attribute object
    • message string

      Error message for the operation
  • 404

    Not found

    Hide response attribute Show response attribute object
    • message string

      Error message for the operation
  • 405

    Wrong method

    Hide response attribute Show response attribute object
    • message string

      Error message for the operation
  • 429

    Too many requests

    Hide response attribute Show response attribute object
    • message string

      Error message for the operation
  • 500

    Internal bug. Please file a bug report at bubble.io/support/report with the request that triggers this bug

    Hide response attributes Show response attributes object
  • 503

    Service Unavailable

    Hide response attribute Show response attribute object
    • message string

      Error message for the operation
POST /wf/run_workflow 
curl \
 -X POST https://app.docuguru.io/api/1.1/wf/run_workflow?api_token=api_token_value \
 -H "Content-Type: application/json" \
 -d '{"workflow_uuid":"string","file":{"filename":"string","contents":"string","private":true,"attach_to":"string"},"custom_data":"string"}'
Request examples 
{
  "workflow_uuid": "string",
  "file": {
    "filename": "string",
    "contents": "string",
    "private": true,
    "attach_to": "string"
  },
  "custom_data": "string"
}
{
  "workflow_uuid": "string",
  "file": "https://example.com",
  "custom_data": "string"
}
Request examples 
{
  "workflow_uuid": "string",
  "file": {
    "filename": "string",
    "contents": "string",
    "private": true,
    "attach_to": "string"
  },
  "custom_data": "string"
}
{
  "workflow_uuid": "string",
  "file": "https://example.com",
  "custom_data": "string"
}
Response examples (200) 
{
  "status": "string",
  "response": {
    "document_status": "string",
    "document_uuid": "string"
  }
}
Response examples (200) 
{
  "status": "string",
  "response": {
    "document_status": "string",
    "document_uuid": "string"
  }
}
Response examples (400) 
{
  "status": "string",
  "message": "string"
}
Response examples (400) 
{
  "status": "string",
  "message": "string"
}
Response examples (401) 
{
  "message": "string"
}
Response examples (401) 
{
  "message": "string"
}
Response examples (404) 
{
  "message": "string"
}
Response examples (404) 
{
  "message": "string"
}
Response examples (405) 
{
  "message": "string"
}
Response examples (405) 
{
  "message": "string"
}
Response examples (429) 
{
  "message": "string"
}
Response examples (429) 
{
  "message": "string"
}
Response examples (500) 
{
  "code": "string",
  "message": "string"
}
Response examples (500) 
{
  "code": "string",
  "message": "string"
}
Response examples (503) 
{
  "message": "string"
}
Response examples (503) 
{
  "message": "string"
}