Skip to main content
API version 2024.0 Box Relay Workflows are objects that represent a named collection of flows. You application must be authorized to use the Manage Box Relay application scope within the developer console in order to use this resource.
This resource has a few variations that can be encountered when using the API.The fields that are part of the mini variant are generally returned when the resource is nested within the response for another resource.
​
id
string
example: 11446498The unique identifier for the workflow.
​
type
string
example: workflowThe value will always be workflow.Value is always workflow
​
description
string
example: This workflow sets off a new hire approval flowThe description for a workflow.
​
is_enabled
boolean
example: trueSpecifies if this workflow is enabled.
​
name
string
example: New Hire WorkflowThe name of the workflow.
{
  "id": "11446498",
  "type": "workflow",
  "description": "This workflow sets off a new hire approval flow",
  "is_enabled": true,
  "name": "New Hire Workflow"
}