Scenario Labels
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The team (company) whose labels are listed.
112Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
Fixed palette semantic token name; the UI maps each token to its hex value.
Label created
A team label with the same name already exists.
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
Label deleted
Authentication failed, the token lacks scenarios:write, or an organization-bound token cannot access the label.
For an unbound caller, the label does not exist or the caller cannot edit its team.
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
Fixed palette semantic token name; the UI maps each token to its hex value.
Label updated
Authentication failed, the token lacks scenarios:write, or an organization-bound token cannot access the label.
For an unbound caller, the label does not exist or the caller cannot edit its team.
A team label with the same name already exists.
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
Team label to assign.
{"summary":"Assign a team label","value":42}Scenario IDs to process. The raw array is limited before duplicate IDs are removed. Duplicate IDs are processed once and retain the position of their first occurrence.
Batch processed. This status is also returned when every distinct scenario ID is rejected; inspect results and summary for per-scenario outcomes.
Invalid request body, including an empty array, more than 10,000 raw IDs, or a non-positive/non-int32 ID; also returned with IM903 when scenario labels are disabled.
Authentication failed, the token lacks scenarios:write (IM001), or an organization-bound token cannot access the label — a missing label and an inaccessible label are indistinguishable (SC401).
The /admin route was used by a caller without admin access.
The label does not exist or the caller cannot edit its team (IM013).
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
Team label to remove.
{"summary":"Remove a team label","value":42}Scenario IDs to process. The raw array is limited before duplicate IDs are removed. Duplicate IDs are processed once and retain the position of their first occurrence.
Batch processed. This status is also returned when every distinct scenario ID is rejected; inspect results and summary for per-scenario outcomes.
Invalid request body, including an empty array, more than 10,000 raw IDs, or a non-positive/non-int32 ID; also returned with IM903 when scenario labels are disabled.
Authentication failed, the token lacks scenarios:write (IM001), or an organization-bound token cannot access the label — a missing label and an inaccessible label are indistinguishable (SC401).
The /admin route was used by a caller without admin access.
The label does not exist or the caller cannot edit its team (IM013).
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
Label assigned
Authentication failed, the token lacks scenarios:write, or an organization-bound token cannot access the label.
Insufficient rights — the user lacks scenario-edit permission, the scenario does not exist or is not accessible, or a label visible to the caller belongs to a different team than the scenario.
For an unbound caller, the label does not exist or the caller cannot edit its team.
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
Label removed
Authentication failed, the token lacks scenarios:write, or an organization-bound token cannot access the label.
Insufficient rights — the user lacks scenario-edit permission, the scenario does not exist or is not accessible, or a label visible to the caller belongs to a different team than the scenario.
For an unbound caller, the label does not exist or the caller cannot edit its team.
Last updated

