Create a mailbox | Monite Documentation

Create a new mailbox

AuthorizationBearer

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

This endpoint expects an object.

mailbox_domain_idstringRequiredformat: "uuid"

mailbox_namestringRequired

related_object_typeenumRequired

Related object type: payable and so on

Allowed values:

Successful Response

idstringformat: "uuid"

Mailbox UUID

mailbox_full_addressstring

mailbox_namestring

related_object_typestring

statusstring

mailbox_domain_idstringformat: "uuid"

401

Post Mailboxes Request Unauthorized Error

403

Post Mailboxes Request Forbidden Error

409

Post Mailboxes Request Conflict Error

422

Post Mailboxes Request Unprocessable Entity Error

429

Post Mailboxes Request Too Many Requests Error

1	curl -X POST https://api.sandbox.monite.com/v1/mailboxes \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"mailbox_domain_id": "mailbox_domain_id",
8	"mailbox_name": "mailbox_name",
9	"related_object_type": "payable"
10	}'

1	{
2	"id": "id",
3	"mailbox_full_address": "mailbox_full_address",
4	"mailbox_name": "mailbox_name",
5	"related_object_type": "related_object_type",
6	"status": "status",
7	"mailbox_domain_id": "mailbox_domain_id"
8	}