FreeCustom.Email APIV1Inboxes

Register an inbox

View as Markdown

Registers an inbox for API use.

Platform domain inbox: The domain must appear in GET /v1/domains for your plan.

Custom domain inbox: The domain must be added and verified via POST /v1/custom-domains + POST /v1/custom-domains/{domain}/verify before registering inboxes at it. Requires Growth+ plan.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
inboxstringRequiredformat: "email"

Response

OK
inboxstring
messagestring
successboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error