Workflows V2

Manage workflows.

Workflows allow you to automate certain actions and behaviors based on specific triggers.

ListWorkflows Workflows V2

List all workflows

Responses

200

OK response.

get/v2/workflows

Request samples

curl

Response samples

application/json

{"workflows": [{"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"continue_on_step_error": true,
"delay": {"conditions_apply_over_delay": false,
"for_seconds": 60
},
"expressions": [{"else_branch": {"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
},
"label": "Team Slack channel",
"operations": [{"branches": {"branches": [{"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": {"array": true,
"type": "IncidentStatus"
}
},
"filter": {"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
]
},
"navigate": {"reference": "1235",
"reference_label": "Teams"
},
"operation_type": "navigate",
"parse": {"returns": {"array": true,
"type": "IncidentStatus"
},
"source": "metadata.annotations[\"github.com/repo\"]"
},
"returns": {"array": true,
"type": "IncidentStatus"
}
}
],
"reference": "abc123",
"returns": {"array": true,
"type": "IncidentStatus"
},
"root_reference": "incident.status"
}
],
"folder": "My folder 01",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"include_private_incidents": true,
"name": "My little workflow",
"once_for": [{"array": false,
"key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]",
"label": "Incident -> Affected Team",
"type": "IncidentSeverity"
}
],
"runs_from": "2021-08-17T13:28:57.801578Z",
"runs_on_incident_modes": ["standard",
"test",
"retrospective"
],
"runs_on_incidents": "newly_created",
"shortform": "page-the-ceo",
"state": "active",
"steps": [{"label": "PagerDuty Escalate",
"name": "pagerduty.escalate"
}
],
"trigger": {"label": "Incident Updated",
"name": "incident.updated"
},
"version": 3
}
]
}

CreateWorkflow Workflows V2

Create a new workflow

Request

Request Body schema: application/json
required

	object Annotations that track metadata about this resource
required	Array of objects (ConditionGroupPayloadV2) Conditions that apply to the workflow trigger
continue_on_step_error required	boolean Whether to continue executing the workflow if a step fails
	object (WorkflowDelayV2)
required	Array of objects (ExpressionPayloadV2) The expressions to use in the workflow
folder	string Folder to display the workflow in
include_private_incidents required	boolean Whether to include private incidents
name required	string Name provided by the user when creating the workflow
once_for required	Array of strings This workflow will run 'once for' a list of references
runs_on_incident_modes required	Array of strings Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents. Items Enum: "standard" "test" "retrospective"
runs_on_incidents required	string Which incidents should the workflow be applied to? Enum: "newly_created" "newly_created_and_active"
shortform	string The shortform used to trigger this workflow (only applicable for manual triggers)
state	string What state this workflow is in Enum: "active" "disabled" "draft" "error"
required	Array of objects (StepConfigPayloadV2) Steps that are executed as part of the workflow
trigger required	string Trigger to set on the workflow

Responses

201

Created response.

post/v2/workflows

Request samples

Payload
curl

application/json

{"annotations": {"incident.io/terraform/version": "3.0.0"
},
"condition_groups": [{"conditions": [{"operation": "one_of",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": "incident.severity"
}
]
}
],
"continue_on_step_error": true,
"delay": {"conditions_apply_over_delay": false,
"for_seconds": 60
},
"expressions": [{"else_branch": {"result": {"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
},
"label": "Team Slack channel",
"operations": [{"branches": {"branches": [{"condition_groups": [{"conditions": [{"operation": "one_of",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": "incident.severity"
}
]
}
],
"result": {"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": {"array": true,
"type": "IncidentStatus"
}
},
"filter": {"condition_groups": [{"conditions": [{"operation": "one_of",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": "incident.severity"
}
]
}
]
},
"navigate": {"reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]"
},
"operation_type": "navigate",
"parse": {"returns": {"array": true,
"type": "IncidentStatus"
},
"source": "metadata.annotations[\"github.com/repo\"]"
}
}
],
"reference": "abc123",
"root_reference": "incident.status"
}
],
"folder": "My folder 01",
"include_private_incidents": true,
"name": "My little workflow",
"once_for": ["incident.url"
],
"runs_on_incident_modes": ["standard",
"test",
"retrospective"
],
"runs_on_incidents": "newly_created",
"shortform": "page-the-ceo",
"state": "active",
"steps": [{"for_each": "abc123",
"id": "abc123",
"name": "pagerduty.escalate",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
]
}
],
"trigger": "incident.updated"
}

Response samples

application/json

{"management_meta": {"annotations": {"incident.io/terraform/version": "3.0.0"
},
"managed_by": "dashboard",
"source_url": "https://github.com/my-company/infrastructure"
},
"workflow": {"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"continue_on_step_error": true,
"delay": {"conditions_apply_over_delay": false,
"for_seconds": 60
},
"expressions": [{"else_branch": {"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
},
"label": "Team Slack channel",
"operations": [{"branches": {"branches": [{"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": {"array": true,
"type": "IncidentStatus"
}
},
"filter": {"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
]
},
"navigate": {"reference": "1235",
"reference_label": "Teams"
},
"operation_type": "navigate",
"parse": {"returns": {"array": true,
"type": "IncidentStatus"
},
"source": "metadata.annotations[\"github.com/repo\"]"
},
"returns": {"array": true,
"type": "IncidentStatus"
}
}
],
"reference": "abc123",
"returns": {"array": true,
"type": "IncidentStatus"
},
"root_reference": "incident.status"
}
],
"folder": "My folder 01",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"include_private_incidents": true,
"name": "My little workflow",
"once_for": [{"array": false,
"key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]",
"label": "Incident -> Affected Team",
"type": "IncidentSeverity"
}
],
"runs_from": "2021-08-17T13:28:57.801578Z",
"runs_on_incident_modes": ["standard",
"test",
"retrospective"
],
"runs_on_incidents": "newly_created",
"shortform": "page-the-ceo",
"state": "active",
"steps": [{"for_each": "abc123",
"id": "abc123",
"label": "PagerDuty Escalate",
"name": "pagerduty.escalate",
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
]
}
],
"trigger": {"label": "Incident Updated",
"name": "incident.updated"
},
"version": 3
}
}

DestroyWorkflow Workflows V2

Archives a workflow

Request

path Parameters

required

string

Unique identifier for the workflow

Example: 01FCNDV6P870EA6S7TK1DSYDG0

Responses

204

No Content response.

delete/v2/workflows/{id}

Request samples

curl

ShowWorkflow Workflows V2

Show a workflow by ID

Request

path Parameters

required

string

Unique identifier for the workflow

Example: 01FCNDV6P870EA6S7TK1DSYDG0

Responses

200

OK response.

get/v2/workflows/{id}

Request samples

curl

Response samples

application/json

{"management_meta": {"annotations": {"incident.io/terraform/version": "3.0.0"
},
"managed_by": "dashboard",
"source_url": "https://github.com/my-company/infrastructure"
},
"workflow": {"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"continue_on_step_error": true,
"delay": {"conditions_apply_over_delay": false,
"for_seconds": 60
},
"expressions": [{"else_branch": {"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
},
"label": "Team Slack channel",
"operations": [{"branches": {"branches": [{"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": {"array": true,
"type": "IncidentStatus"
}
},
"filter": {"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
]
},
"navigate": {"reference": "1235",
"reference_label": "Teams"
},
"operation_type": "navigate",
"parse": {"returns": {"array": true,
"type": "IncidentStatus"
},
"source": "metadata.annotations[\"github.com/repo\"]"
},
"returns": {"array": true,
"type": "IncidentStatus"
}
}
],
"reference": "abc123",
"returns": {"array": true,
"type": "IncidentStatus"
},
"root_reference": "incident.status"
}
],
"folder": "My folder 01",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"include_private_incidents": true,
"name": "My little workflow",
"once_for": [{"array": false,
"key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]",
"label": "Incident -> Affected Team",
"type": "IncidentSeverity"
}
],
"runs_from": "2021-08-17T13:28:57.801578Z",
"runs_on_incident_modes": ["standard",
"test",
"retrospective"
],
"runs_on_incidents": "newly_created",
"shortform": "page-the-ceo",
"state": "active",
"steps": [{"for_each": "abc123",
"id": "abc123",
"label": "PagerDuty Escalate",
"name": "pagerduty.escalate",
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
]
}
],
"trigger": {"label": "Incident Updated",
"name": "incident.updated"
},
"version": 3
}
}

UpdateWorkflow Workflows V2

Updates a workflow

Request

path Parameters

required

string

ID of the workflow to update

Examples:

default 01FCNDV6P870EA6S7TK1DSYDG0

Request Body schema: application/json
required

	object Annotations that track metadata about this resource
required	Array of objects (ConditionGroupPayloadV2) Conditions that apply to the workflow trigger
continue_on_step_error required	boolean Whether to continue executing the workflow if a step fails
	object (WorkflowDelayV2)
required	Array of objects (ExpressionPayloadV2) The expressions to use in the workflow
folder	string Folder to display the workflow in
include_private_incidents required	boolean Whether to include private incidents
name required	string Name provided by the user when creating the workflow
once_for required	Array of strings This workflow will run 'once for' a list of references
runs_on_incident_modes required	Array of strings Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents. Items Enum: "standard" "test" "retrospective"
runs_on_incidents required	string Which incidents should the workflow be applied to? Enum: "newly_created" "newly_created_and_active"
shortform	string The shortform used to trigger this workflow (only applicable for manual triggers)
state	string What state this workflow is in Enum: "active" "disabled" "draft" "error"
required	Array of objects (StepConfigPayloadV2) Steps that are executed as part of the workflow

Responses

200

OK response.

put/v2/workflows/{id}

Request samples

Payload
curl

application/json

{"annotations": {"incident.io/terraform/version": "3.0.0"
},
"condition_groups": [{"conditions": [{"operation": "one_of",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": "incident.severity"
}
]
}
],
"continue_on_step_error": true,
"delay": {"conditions_apply_over_delay": false,
"for_seconds": 60
},
"expressions": [{"else_branch": {"result": {"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
},
"label": "Team Slack channel",
"operations": [{"branches": {"branches": [{"condition_groups": [{"conditions": [{"operation": "one_of",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": "incident.severity"
}
]
}
],
"result": {"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": {"array": true,
"type": "IncidentStatus"
}
},
"filter": {"condition_groups": [{"conditions": [{"operation": "one_of",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": "incident.severity"
}
]
}
]
},
"navigate": {"reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]"
},
"operation_type": "navigate",
"parse": {"returns": {"array": true,
"type": "IncidentStatus"
},
"source": "metadata.annotations[\"github.com/repo\"]"
}
}
],
"reference": "abc123",
"root_reference": "incident.status"
}
],
"folder": "My folder 01",
"include_private_incidents": true,
"name": "My little workflow",
"once_for": ["incident.url"
],
"runs_on_incident_modes": ["standard",
"test",
"retrospective"
],
"runs_on_incidents": "newly_created",
"shortform": "page-the-ceo",
"state": "active",
"steps": [{"for_each": "abc123",
"id": "abc123",
"name": "pagerduty.escalate",
"param_bindings": [{"array_value": [{"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"literal": "SEV123",
"reference": "incident.severity"
}
}
]
}
]
}

Response samples

application/json

{"management_meta": {"annotations": {"incident.io/terraform/version": "3.0.0"
},
"managed_by": "dashboard",
"source_url": "https://github.com/my-company/infrastructure"
},
"workflow": {"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"continue_on_step_error": true,
"delay": {"conditions_apply_over_delay": false,
"for_seconds": 60
},
"expressions": [{"else_branch": {"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
},
"label": "Team Slack channel",
"operations": [{"branches": {"branches": [{"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
],
"result": {"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": {"array": true,
"type": "IncidentStatus"
}
},
"filter": {"condition_groups": [{"conditions": [{"operation": {"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {"label": "Incident Severity",
"reference": "incident.severity"
}
}
]
}
]
},
"navigate": {"reference": "1235",
"reference_label": "Teams"
},
"operation_type": "navigate",
"parse": {"returns": {"array": true,
"type": "IncidentStatus"
},
"source": "metadata.annotations[\"github.com/repo\"]"
},
"returns": {"array": true,
"type": "IncidentStatus"
}
}
],
"reference": "abc123",
"returns": {"array": true,
"type": "IncidentStatus"
},
"root_reference": "incident.status"
}
],
"folder": "My folder 01",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"include_private_incidents": true,
"name": "My little workflow",
"once_for": [{"array": false,
"key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]",
"label": "Incident -> Affected Team",
"type": "IncidentSeverity"
}
],
"runs_from": "2021-08-17T13:28:57.801578Z",
"runs_on_incident_modes": ["standard",
"test",
"retrospective"
],
"runs_on_incidents": "newly_created",
"shortform": "page-the-ceo",
"state": "active",
"steps": [{"for_each": "abc123",
"id": "abc123",
"label": "PagerDuty Escalate",
"name": "pagerduty.escalate",
"param_bindings": [{"array_value": [{"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {"label": "Lawrence Jones",
"literal": "SEV123",
"reference": "incident.severity"
}
}
]
}
],
"trigger": {"label": "Incident Updated",
"name": "incident.updated"
},
"version": 3
}
}

➔ Next to Webhooks

Workflows V2

ListWorkflows Workflows V2

CreateWorkflow Workflows V2

Request Body schema: application/jsonrequired

DestroyWorkflow Workflows V2

path Parameters

ShowWorkflow Workflows V2

path Parameters

UpdateWorkflow Workflows V2

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required