Import a workflow

Create a new workflow definition and its first version using the exported JSON document of an existing workflow version.

User Access Permission

You must be assigned the Workflow Manage Access permission to run this operation.

Request
query Parameters
workflow_definition_id
integer

The unique id of the workflow definition to import a workflow version under.

version
string

The version number of the new workflow version to import. Must be greater than any existing version numbers.

activate
boolean

Indicates whether the imported version is an active version. Default to be false.

header Parameters
Idempotency-Key
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.

Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
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 (:), semicolon (;), double quote ("), and quote (').

Request Body schema: application/json
Array of objects (Linkage)
Array of objects (Task)
object (workflow)

A workflow.

Responses
200

OK

post/workflows/import
Request samples
application/json
{
  • "linkages": [
    ],
  • "tasks": [
    ],
  • "workflow": {
    }
}
Response samples
application/json
{
  • "calloutTrigger": true,
  • "createdAt": "2019-10-03T14:14:39.139Z",
  • "description": "",
  • "id": 403,
  • "interval": null,
  • "name": "Call Echo",
  • "ondemandTrigger": true,
  • "scheduledTrigger": false,
  • "timezone": null,
  • "type": "Workflow::Setup",
  • "updatedAt": "2019-10-03T14:14:39.139Z",
  • "version": "0.0.1"
}