post https://{host}/v2/organization/labels
This API allows you to add new customer labels to your organization. Before using it, ensure the label limit for your organization is properly configured, as you cannot add labels beyond this number. This limit must be set at the organization level using the POST organization/configs API with the ORG_MAX_LABEL_COUNT parameter and cannot be configured through the user interface. If you attempt to add labels exceeding this limit, the system will block the request and return an error.
NoteFor detailed information about the APIs and for hands-on testing, refer to the API overview documentation and step-by-step guide on making your first API call.
Prerequisites
- Basic Authentication
- Default access group
Resource information
URL | /organization/labels |
HTTP Method | GET |
Pagination | No |
Batch support | No |
Rate limit information | None |
API Endpoint
https://eu.api.capillarytech.com/v2/organization/labels
Example request
curl --location 'https://eu.api.capillarytech.com/v2/organization/labels' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic *****' \
--header 'Cookie: _cfuvid=suFj8RO2mrlXOut2Fa7ukoWvca.9BKPkdKXq1mrH7Fg-1736904971714-0.0.1.1-604800000; _cfuvid=oQ3H153LTM8nT.gh0fhBj8XXHgFGhIKuoi8lOxyh.c4-1751970693920-0.0.1.1-604800000' \
--data '{
"orgLabels": [
{
"name": "DocDemoLabel",
"description":"Label for DocDemo"
}
]
}'
Request Body Parameters
Parameter | Datatype | Description |
---|---|---|
orgLabels* | Array | List of labels to be added. Each object must include the fields below. |
-name* | String | Name of the label or tag. Recommended max length: 50 characters. |
-description | String | Short description of the label. Recommended max length: 255 characters. |
Response Body Parameters
Parameter | Datatype | Description |
---|---|---|
entity* | Integer | ID of the created or updated entity. |
warnings | Array of string | List of warnings returned by the system. When no warnings are present, this array will be empty. |
Error Code
Error Code | Message | Description |
---|---|---|
200 | OK | Request processed successfully. The entity was created or updated without errors. |
400 | Bad Request | The request is invalid. Possible reasons include missing required parameters, invalid input data, or malformed request body. |
401 | Unauthorized | Authentication failed or the API token is missing or invalid. |
403 | Forbidden | Access is not allowed due to insufficient permissions. |
404 | Not Found | The requested resource was not found. |
409 | Conflict | The request could not be completed due to a conflict with the current state of the resource. |
500 | Internal Server Error | An unexpected error occurred on the server side. |
33003 | Invalid Array | The request body contains an empty array. At least one valid object is required in the array. |