Update a workflow
Skip to content
v1 API
/
/
Update a workflow

Update a workflow

Request

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.

Security
bearerAuth
Path
workflow_idstringrequired

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

Headers
Idempotency-Keystring, <= 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-Encodingstring

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-Encodingstring

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-Idstring, <= 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-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Bodyapplication/json
active_workflow_version_idinteger

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

descriptionstring

The description of the workflow defintion

Example:"Retrieve and update products"
namestring

The name of the workflow definition

statusstring

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

{
  "description": "Retrieve and update products"
}

Responses

OK

Headers
Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json
active_versionobject(workflow)

Information of the active version.

callTypestring

The call type of the active version.

This field is only returned for workflows that are configured as UI actions.

calloutTriggerboolean

Indicates whether the callout trigger is enabled for the retrieved workflow.

createdAtstring, (date-time)

The date and time when the workflow is created, in the YYYY-MM-DDThh:mm:ss.sssZ format.

descriptionstring

The description of the workflow definition.

idinteger

The unique ID of the workflow definition.

intervalstring or null

The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.

namestring

The name of the workflow definition.

ondemandTriggerboolean

Indicates whether the ondemand trigger is enabled for the workflow.

prioritystring

The priority of the active version.

scheduledTriggerboolean

Indicates whether the scheduled trigger is enabled for the workflow.

statusstring

The status of the workflow definition.

timezonestring or null

The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.

uiPagesobject

The UI pages that are configured for the active version.

This field is only returned for workflows that are configured as UI actions.

ui_page_rolesArray of strings

The roles that are allowed to access the UI pages of the workflow definition.

This field is only returned for workflows that are configured as UI actions.

updatedAtstring, (date-time)

The date and time when the workflow is updated the last time, in the YYYY-MM-DDThh:mm:ss.sssZ format.

zuora_org_idsArray of strings

The IDs of the organizations that the workflow definition belongs to.

Response
{
  "id": 265,
  "name": "Refresh products",
  "description": "Retrieve and update products",
  "status": "Active",
  "ondemandTrigger": true,
  "calloutTrigger": true,
  "scheduledTrigger": false,
  "interval": null,
  "timezone": null,
  "createdAt": "2021-02-04T13:39:10.530+08:00",
  "updatedAt": "2021-07-23T11:43:48.576+08:00",
  "active_version": {
    "id": 265,
    "description": "the first description",
    "type": "Workflow::Setup",
    "version": "0.0.1",
    "status": "Active"
  }
}