Create a mailbox domain

POST

/mailbox_domains

Create domain for the partner_id

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

Request

This endpoint expects an object.

domainstringRequiredformat: "hostname"

The domain name, such as mail.mycompany.com. Can contain only alphanumeric characters (A..Z a..z 0..9), dots (.), and hyphens (-). Each segment of the domain name must start and end with either a letter or a digit.

Response

Successful Response

idstringformat: "uuid"

Entry UUID

dns_recordsobject or map from strings to any

domainstringformat: "hostname"

The domain name.

statusstring

dedicated_ipstringOptional

A dedicated IP address assigned to this mailbox and used to send outgoing email.

last_updated_atdatetimeOptional

The time the domain was updated for the last time

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/mailbox_domains \
2      -H "x-monite-version: 2024-05-25" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "domain": "domain"
7 }'

201Created

1 {
2   "id": "id",
3   "dns_records": {
4     "receiving_dns_records": [
5       {
6         "is_active": true,
7         "name": "name",
8         "record_purpose": "DKIM",
9         "record_type": "TXT",
10         "valid": "valid",
11         "value": "value"
12       }
13     ],
14     "sending_dns_records": [
15       {
16         "is_active": true,
17         "name": "name",
18         "record_purpose": "DKIM",
19         "record_type": "TXT",
20         "valid": "valid",
21         "value": "value"
22       }
23     ]
24   },
25   "domain": "domain",
26   "status": "status",
27   "dedicated_ip": "dedicated_ip",
28   "last_updated_at": "2024-01-15T09:30:00Z"
29 }

Delete a mailbox domain

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/mailbox_domains \
2	-H "x-monite-version: 2024-05-25" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"domain": "domain"
7	}'

1	{
2	"id": "id",
3	"dns_records": {
4	"receiving_dns_records": [
5	{
6	"is_active": true,
7	"name": "name",
8	"record_purpose": "DKIM",
9	"record_type": "TXT",
10	"valid": "valid",
11	"value": "value"
12	}
13	],
14	"sending_dns_records": [
15	{
16	"is_active": true,
17	"name": "name",
18	"record_purpose": "DKIM",
19	"record_type": "TXT",
20	"valid": "valid",
21	"value": "value"
22	}
23	]
24	},
25	"domain": "domain",
26	"status": "status",
27	"dedicated_ip": "dedicated_ip",
28	"last_updated_at": "2024-01-15T09:30:00Z"
29	}