Buy mailboxes - InboxKit

Purchase mailboxes for specified domains

curl --location --request POST 'https://api.inboxkit.com/v1/api/mailboxes/buy' \ --header 'X-Workspace-Id;' \ --header 'Content-Type: application/json' \ --data-raw '{ "uids": [ "string" ], "mailboxes": [ { "first_name": "John", "last_name": "Doe", "profile_picture": "string", "username": "john.doe", "platform": "GOOGLE" } ] }'

{ "error": false, "message": "Mailbox details retrieved successfully", "mailboxes": [ { "uid": "string", "first_name": "string", "last_name": "string", "username": "string", "platform": "string", "domain": "string" } ] }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

X-Workspace-Id

string <uuid>

required

Workspace identifier

Body Params application/json

uids

array[string]

required

Domain UIDs to create mailboxes for

mailboxes

array [object {5}]

required

Mailbox configurations

first_name

string

required

Example:

John

last_name

string

required

Example:

Doe

profile_picture

string | null

optional

Profile picture URL

username

string

required

Example:

john.doe

platform

enum<string>

required

Allowed values:

GOOGLEMICROSOFT

Default:

GOOGLE

Examples

Responses

🟢200OK

application/json

Mailboxes created successfully

Body

error

boolean

optional

Example:

false

message

string

optional

Example:

Mailbox details retrieved successfully

mailboxes

array [object {6}]

optional

Created mailboxes

uid

string

optional

first_name

string

optional

last_name

string

optional

username

string

optional

platform

string

optional

domain

string

optional

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error