Update Approval on a Workflow

patch

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

Updates an approval to the specified status. Approvals can only be updated during the Review step and when a given approval group is active (when it is that group's turn to approve).

OAuth Scope required: public.workflows.updateApprovals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

roleId

string

required

The unique identifier of the approver role whose status should be changed. This identifier can be retrieved using the GET /workflows/{id}/approvals endpoint.

Body Params

Note that user is required when approving with a legacy bearer token but will be ignored when approving via an OAuth token. If the token was generated with the Authorization Code grant, the associated token user will be used. If the token was generated with the Client Credentials grant, the required x-as-user-id or 'x-as-user-email` header will be used.

user

object

The Ironclad user approving the workflow. The user must be currently assigned as the approver.

status

string

enum

required

The new approval status.

Allowed:

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

Loading…

Response

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

application/json

200200

400400