Access

Update access permission details of the workflow stage

Updates the access permission configuration for a specific stage in the workflow including role assignment, record visibility scope and edit permission level

<b>Notes:</b> Record Visibility Scope Values:

  • <b>My Items</b> – Limits record visibility to items created by or assigned to the user
  • <b>My Team</b> – Allows visibility of records owned by users within the same team
  • <b>All Items</b> – Grants visibility to all records in the workflow

Sample request:

PUT 
{
     "WorkflowName" : "Test Workflow",
     "StageName" : "Manager Approval",
     "Role" : "Manager",
     "ViewAccess" : "All Items",
     "EditAccess" : "My Items"
}
put/api/Access

Request

Request body

workflowNamestring required

Name of the worklfow

stageNamestring required

Name of the stage

rolestring required

Name of the role to assign to the stage

viewAccessstring required

View Access value. Value should be [All Items/My Items/My Team]

editAccessstring required

Edit Access value. Value should be [All Items/My Items/My Team/None]

Response

Return status of the request.

statusstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.