Update a workflow

Updates a specific workflow by its ID, which allows you to configure the settings of a workflow via API.

User Access Permission

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

Request
path Parameters
workflow_id
required
string

The unique ID of a workflow definition. For example, 19080.

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

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.

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 (').

Zuora-Entity-Ids
string

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.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
active_workflow_version_id
integer

The id of a version. This version will then be set to the active version of the workflow definition.

description
string

The description of the workflow defintion

name
string

The name of the workflow definition

status
string

Can be Active or Inactive. Active workfow definitions run like normal. Inactive workflow definitions cannot be run.

Responses
200

OK

404

The workflow for the given id does not exist

422

Bad Request for one of the following reasons:

  • The name or description fields are not strings.
  • The ondemand_trigger, callout_trigger, or scheduled_trigger fields are not booleans.
  • The timezone does not match one of the valid values in this spread sheet.
  • The priority is not one of High, Medium, or Low.
  • The status is not one of Active or Inactive.
  • The scheduled_trigger is set to true but a valid timezone and interval were not passed.
patch/workflows/{workflow_id}
Request samples
application/json
{
  • "active_workflow_version_id": 0,
  • "description": "string",
  • "name": "string",
  • "status": "string"
}
Response samples
application/json
{
  • "active_version": {
    },
  • "calloutTrigger": true,
  • "createdAt": "2021-03-24T19:52:37.254Z",
  • "description": "This is my special workflow! It bills everybody",
  • "id": 2,
  • "interval": "0 0 /1 /1 * *",
  • "name": "Bill Customers",
  • "ondemandTrigger": true,
  • "priority": "Low",
  • "scheduledTrigger": true,
  • "status": "Inactive",
  • "timezone": "Eastern Time (US & Canada)",
  • "updatedAt": "2021-04-05T18:35:52.781Z"
}