Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first.
Note: To run a workflow, do not use the following reserved words in the request body of the parameters.
You must be assigned the Workflow Run Access permission to run this operation.
To learn about how to define parameters, see Configure the settings of a workflow.
string <= 255 characters
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.
With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a
The value is in the
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
string <= 64 characters
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.
The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (
Include parameters you want to pass to the workflow.
Callout not enabled for the workflow
The provided body is missing one or more required parameters
The provided workflow_id references a workflow instance
- "paymentId": "4028905f5a87c0ff015a889ddfb800c0",
- "accountId": "4028905f5a87c0ff015a87d25ae90025"
- "id": 400,
- "name": "WF-396-00000003",
- "originalWorkflowId": 396,
- "type": "Workflow::Instance",
- "status": "Queued",
- "createdAt": "2019-09-19 18:25:33 UTC",
- "updatedAt": "2019-09-19 18:25:33 UTC"