Tag

Create Tag

POST

Creates a new Tag based on information you provide.

A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color.

Request

This endpoint expects an object.
name
stringRequired
The name of this Tag.
color
stringOptional

The color that will be used to represent this Tag visually. This color is automatically chosen by the application when a user creates a Tag.

You can choose specify any color that can be represented using HTML RGB syntax such as #0088FF, in the format RRGGBB. You may not use names for colors.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color.
POST
1curl -X POST /api/data/tags \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "name": "name"
6}'
200
Successful
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue",
12 "data": {
13 "id": "id",
14 "name": "name",
15 "color": "color"
16 }
17}