Skip to content

Create a custom tag

POST
/api/v1/custom-tags
curl --request POST \
--url https://external-api.moja-ai.com/api/v1/custom-tags \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "name": "sub_1", "display_name": "Sub ID 1", "description": "example" }'
X-API-Key
Any of:
string
Media typeapplication/json
CustomTagCreate
object
name
required
Name
string
>= 1 characters <= 255 characters
display_name
required
Display Name
string
>= 1 characters <= 255 characters
description
Any of:
string

Successful Response

Media typeapplication/json
CustomTagResponse
object
id
required
Id
string
org_id
required
Org Id
string
name
required
Name
string
display_name
required
Display Name
string
description
Any of:
string
created_at
Any of:
string format: date-time
updated_at
Any of:
string format: date-time
Examplegenerated
{
"id": "example",
"org_id": "example",
"name": "example",
"display_name": "example",
"description": "example",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}

Bad Request

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Unauthorized

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Not Found

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Conflict

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}

Too Many Requests

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}