GuidesAPI ReferenceRecipes
API Reference
Request a Demo

Update Workflow Role Assignment

patch
https://na1.ironcladapp.com/public/api/v1/workflows//roles/

Updates the assignment of the specified role (e.g. Archiver, Signature Coordinator, etc.) on the workflow to a new user. The new assignee must be eligible to be assigned to the role per the workflow definition configured in workflow designer.

OAuth Scope required: public.workflows.updateRoleAssignment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier or Ironclad ID of a workflow.

string
required
length ≤ 200

The display name of the role, URL-encoded (e.g. Legal%20Approver).

Body Params
string
required

The id of the Ironclad user to assign to the role. Must be eligible to be assigned to the role.

Headers
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.

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

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago