Labels API

POST

Create a new label (which can be assigned later to a Context File)

name [String]

Displayed name of the label

externalId [String]

Unique Identifier of the label you can optionally provide

showInDiscovery [Boolean]

Is this label will be visible to the end users ?

PATCH

This method and endpoints using it are used for updating a Label updatable values.

name [String]

Displayed name of the label

showInDiscovery [Boolean]

Is this label will be visible to the end users ?

GET

You can call the main GET endpoint to query the list of labels or get label individually

startAfter - Querying for “the next page” [String]

Use the startAfter parameter and provide the createdAt string of the last label in the current results set

When there are no more results you will receive an empty array in the response and a 404 status code

DELETE

You can delete a label by providing its uid

RESPONSE DATA

You will get the same response data when calling POST, PATCH or GET

uid [String]

Mindset internal label uid

externalId [String]

Unique Identifier of the label you can optionally provide

name [String]

Displayed name of the label

showInDiscovery [Boolean]

Will this label be visible to the end users ?

createdAt [ISO timestamp]

Label creation date