Create a Tag
- 09 Jun 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create a Tag
- Updated on 09 Jun 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/tags
This API creates a new tag, where the name/content of the tag is part of the body parameters.
If you want this new tag to be part of a group of tags, you’ll need to place the group Id in the TagGroupId field.
Tags can be attached to a conversation (object), to a specific comment or a reply (child), or to a customer (user). Set the tag’s attachment options in the boolean parameters (true/false)
The API returns Tag Id.
Security
HTTP
Type bearer
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call. For additional support you can contact us.
Body parameters
Optional description for new mail object in Markdown
object
data
object
Name
string
TagGroupId
integer (int64)
ObjectTag
boolean
Exampletrue
UserTag
boolean
Examplefalse
ChildTag
boolean
Examplefalse
Responses
200
OK
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-08-06T07:51:52.2581942Z
data
object
id
string
Example21221
400
Bad Request - The request could not be understood by the server. Incoming parameters may not be valid
401
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
404
Not found - The requested resource is not found
429
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
500
Server Error - The server could not return the representation due to an internal server error
501
Not Implemented - The requested operation is not supported
Was this article helpful?
