Mailpit SDK Examples
PUT/api/v1/tags/{Tag}

Rename a tag

Renames an existing tag using its current URL-encoded name. Send the new tag name in Name; the request body is optional, but the body schema requires Name when you provide a body.

  • RetriesRetries up to 2×, 250ms backoff, 10s timeout.

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

The new tag name.

Namestringrequired
New name

2 status codes
200Returns the plain-text response `ok`.
400Returned when the rename request fails; the response body contains the error message.

Error handling

A 400 is returned when the rename request fails; inspect the error message in the response body. The Tag path parameter must be the URL-encoded name of the existing tag, and Name must contain the new tag name.