Resources
Workflow Instance Management
Methods Supported
| Method | Endpoint |
|---|---|
| cancelWorkflowInstance Cancel a Running Workflow Instance | POST /v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId}/actions/cancel |
| getWorkflowInstance Retrieve a Workflow Instance | GET /v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId} |
| getWorkflowInstancesForAccount Get Workflow Instances for Account | GET /v1/accounts/{accountId}/workflow-instances |
| getWorkflowInstancesList Retrieve All Workflow Instances | GET /v1/accounts/{accountId}/workflows/{workflowId}/instances |
Workflows
Methods Supported
| Method | Endpoint |
|---|---|
| getWorkflowsList Retrieve a list of available Workflow Builder workflows | GET /v1/accounts/{accountId}/workflows |
| getWorkflowTriggerRequirements Retrieve trigger requirements for a specific Workflow Builder workflow | GET /v1/accounts/{accountId}/workflows/{workflowId}/trigger-requirements |
| pauseNewWorkflowInstances Pause an Active Workflow | POST /v1/accounts/{accountId}/workflows/{workflowId}/actions/pause |
| resumePausedWorkflow Resume a Paused Workflow | POST /v1/accounts/{accountId}/workflows/{workflowId}/actions/resume |
| triggerWorkflow Trigger a new instance of a Workflow Builder workflow | POST /v1/accounts/{accountId}/workflows/{workflowId}/actions/trigger |