Sign in

v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
address book

Delete a Tag

This function is an API endpoint that deletes a tag from 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 an array of tag names to be deleted.

Returns

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

Example

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

["tag1", "tag2"]

delete/api/ab/tag/{ab}

Path parameters

abstring required

Request body

string[] 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"}