Update Workflow Metadata

patch

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/attributes

The workflow must be in the Review step in order for its data to be updated. Use the remove action to clear field values and the set action to add or modify values. Form validation is enforced; required fields cannot be removed and any required fields triggered by conditions must be populated.

Note: This endpoint does not support updating document/file type attributes. To manage documents, use the document-specific endpoints.

OAuth Scope required: public.workflows.updateWorkflows

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

Body Params

updates

array of objects

required

updates*

comment

string

A comment that explains the updates you are making to the workflow.

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

403403

404404