Skip to main content
POST
Create tag

Authorizations

X-API-KEY
string
header
required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Body

application/json

Request body for creating a custom tag.

tag_name
string
required

Display name for the new tag.

Example:

"testing tag 2"

Response

The created tag, including its id for use when updating document metadata.

Detailed information about a tag.

id
string<uuid>
required

Unique identifier for the tag.

Example:

"019a48b4-e573-7203-945a-2e7c4c164217"

name
string
required

Name of the tag (e.g. from:user@email.com, to:user@email.com, broker:Broker Name or a custom one provided by the user).

Example:

"from:user@email.com"

created_at
string<date-time>
required

Timestamp when the tag was created.

Example:

"2025-11-03T07:53:26.150858Z"

updated_at
string<date-time>
required

Timestamp when the tag was last updated.

Example:

"2025-11-03T07:53:26.150859Z"

file_count
integer
required

Number of files associated with this tag.

Example:

40