v1
latestOpenAPI 3.0.02026-07-175652103.9 KBAdd a Tag
This function is an API endpoint that adds a new tag to an address book. It is tagged with "address book" for OpenAPI documentation.
Parameters
-
ab: The identifier of the address book.
-
request: A JSON object containing the new tag to be added.
Returns
If successful, this function returns an ActionResponse::Empty object. <br> If the tag already exists or the user is not authorized to add it, this function returns a status::Unauthorized error. <br>
Errors
This function will return an error if the system is in maintenance mode, or if the tag already exists or the user is not authorized to add it.
Example
POST /api/ab/tag/add/018fab24-0ae5-731c-be23-88aa4518ea26 Content-Type: application/json
{"name": "tag1", "color": "#FF0000"}
Path parameters
Request body
Response
# 200 OK
This response is given when the request is successful.
The body is empty if there is no error,
The body contains a json object with the error {"error":"Error message"}