Skip to main content
POST
Create an entity tag

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json
name
string
required
write-only

Entity tag name

Example:

"Priority Entity"

color
string | null
write-only

Optional display color as a 7-character hexadecimal string (#RRGGBB). Omit or send null to fall back to the default color.

Example:

"#22c558"

Response

Entity tag resource response

@id
string<iri-reference>

Entity Tag IRI reference

Example:

"/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"

@type
string
default:EntityTag

JSON-LD resource type

id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

name
string

Display name for the entity tag

Example:

"Priority Entity"

color
string | null

Lowercase 7-character hexadecimal color used to display the tag (#RRGGBB). Defaults to #a3aab5 when an entity tag is created without a color.

Example:

"#22c558"

createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"