Skip to main content
POST
/
mailboxes
Create a mailbox
curl --request POST \
  --url https://api.sandbox.monite.com/v1/mailboxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "mailbox_domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mailbox_name": "<string>",
  "related_object_type": "payable"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mailbox_full_address": "<string>",
  "mailbox_name": "<string>",
  "related_object_type": "<string>",
  "status": "<string>",
  "mailbox_domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
​
mailbox_domain_id
string<uuid>
required
​
mailbox_name
string
required
​
related_object_type
enum<string>
required

Related object type: payable and so on

Available options:
payable,
receipt

Response

Successful Response

​
id
string<uuid>
required

Mailbox UUID

​
mailbox_full_address
string
required
​
mailbox_name
string
required
​
related_object_type
string
required
​
status
string
required
​
mailbox_domain_id
string<uuid>