For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • FreeCustom.Email API
        • GETList inboxes
        • POSTRegister an inbox
LogoLogo
FreeCustom.Email APIV1Inboxes

Register an inbox

||View as Markdown|
POST
https://api2.freecustom.email/v1/inboxes
POST
/v1/inboxes
$curl -X POST https://api2.freecustom.email/v1/inboxes \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "inbox": "test@ditube.info"
>}'
1{
2  "success": true,
3  "message": "Inbox already registered.",
4  "inbox": "string"
5}
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.
Was this page helpful?
Previous

List inboxes

Next

Unregister an inbox

Built with

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
successboolean
messagestring
inboxstring

Errors

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