Get Started
Usage API
More information

POST api/2.0/mailserver/mailboxes/add This function requires authentication

Description

Creates a mailbox with the parameters specified in the request.

Parameters
Name Description Type Example
name
sent in body
Mailbox name string some text
local_part
sent in body
Mailbox local part string some text
domain_id
sent in body
Mailbox domain ID number 1234
user_id
sent in body
User ID string some text
notifyCurrent
sent in body
Specifies if the notifications will be sent to the email address from which this mailbox was created or not Bool value true
notifyProfile
sent in body
Specifies if the notifications will be sent to the email address from the current user's profile or not Bool value true
Example
POST api/2.0/mailserver/mailboxes/add
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "name": "some text",
  "local_part": "some text",
  "domain_id": 1234,
  "user_id": "some text",
  "notifyCurrent": true,
  "notifyProfile": true
}
Returns

Mailbox data associated with the tenant