mailpit unofficial
PUT/api/v1/tags/{Tag}

Rename a tag

Renames an existing tag. Use Tag to identify the tag and provide Name as its replacement name. The request body is optional, but when supplied it must include Name.

1 parameter · 1 body field
Tagstringrequired
The URL-encoded name of the tag to rename.

Optional tag rename details. When provided, the body must include Name.

Namestringrequired
New name

2 status codes
200Returns the plain-text response `ok`.
400Returned when the server encounters an error. The response body contains the error message.

Error handling

A 400 is returned when the server encounters an error; the response body contains the error message. The Tag path parameter must contain the URL-encoded name of the tag to rename. When you provide a request body, it must include Name as the new tag name.