PUT api/2.0/mailserver/mailboxes/update This function requires authentication

Description

Updates a mailbox with the ID specified in the request.

Parameters

Name	Description	Type	Example
mailbox_id sent in body	Mailbox ID	number	1234
name sent in body	New sender name	string	some text

Example

PUT api/2.0/mailserver/mailboxes/update
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "mailbox_id": 1234,
  "name": "some text"
}

Returns

Updated mailbox data

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": 1234,
    "UserId": "UserId",
    "UserDisplayName": "UserDisplayName",
    "Address": {
      "Id": 1234,
      "DomainId": 1234,
      "Email": "Email@only.com"
    },
    "Name": "Name",
    "Aliases": [
      {
        "Id": 1234,
        "DomainId": 1234,
        "Email": "Email@only.com"
      }
    ]
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>1234</Id>
    <UserId>UserId</UserId>
    <UserDisplayName>UserDisplayName</UserDisplayName>
    <Address>
      <Id>1234</Id>
      <DomainId>1234</DomainId>
      <Email>Email@only.com</Email>
    </Address>
    <Name>Name</Name>
    <Aliases>
      <Id>1234</Id>
      <DomainId>1234</DomainId>
      <Email>Email@only.com</Email>
    </Aliases>
  </response>
</result>