Desk

Rename the team’s own address

Gives the address a new name before the @, while no message has arrived at it. Each name belongs to one team, and a name once given to a team that has since been erased is never given again. Once mail has arrived the name stays, because somebody may write to it again.

patch/api/v1/mail/hosted

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/mail/hosted
  • Auth: API key in cookie better-auth.session_token

Request body

namestring required

What goes before the @: letters, digits, dots and dashes.

Response

The address under its new name.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.