Sign in

v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
address book

Update a Tag

This function is an API endpoint that updates a tag in 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 updated tag.

Returns

If successful, this function returns an ActionResponse::Empty object. <br> If the tag does not exist or the user is not authorized to update 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 does not exist or the user is not authorized to update it.

Example

PUT /api/ab/tag/update/018fab24-0ae5-731c-be23-88aa4518ea26 Content-Type: application/json

{"name": "tag1", "color": "#FF0000"}

put/api/ab/tag/update/{ab}

Path parameters

abstring required

Request body

namestring required
colorinteger required

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"}