Update a mailbox

PUT /api/2.0/mailserver/mailboxes/update

Request

Updates a mailbox with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json.
Content-Typeenum of string: Can be one of: application/json.

Body

mailbox_idinteger: Mailbox ID
namestring: New sender name

Examples

PUT /api/2.0/mailserver/mailboxes/update HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url https://example.com/api/2.0/mailserver/mailboxes/update \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated mailbox data

Idintegerformat: int32

UserIdstring

UserDisplayNamestring

Addressobject

Idintegerformat: int32
DomainIdintegerformat: int32
Emailstring

Namestring

Aliasesarray of object

Idintegerformat: int32
DomainIdintegerformat: int32
Emailstring

401

Unauthorized

Get Help

If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).