Check mailbox status

Check the status of specified mailboxes

curl --location --request POST 'https://api.inboxkit.com/v1/api/mailboxes/status' \ --header 'X-Workspace-Id;' \ --header 'Content-Type: application/json' \ --data-raw '{ "uids": [ "string" ], "domain_uids": [ "string" ], "page": 0, "limit": 0 }'

{ "error": false, "message": "Mailbox status retrieved successfully", "mailboxes": [ { "uid": "string", "status": "string", "first_name": "string", "last_name": "string", "username": "string", "platform": "string" } ], "page": 0, "limit": 0, "total": 0 }

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]

optional

Mailbox UIDs to check status for

domain_uids

array[string]

optional

Check mailbox status by domain uids

page

integer

optional

limit

integer

optional

Examples

Responses

🟢200OK

application/json

Mailbox status retrieved successfully

Body

error

boolean

optional

Example:

false

message

string

optional

Example:

Mailbox status retrieved successfully

mailboxes

array [object {6}]

optional

Mailboxes with current status

uid

string

optional

status

string

optional

first_name

string

optional

last_name

string

optional

username

string

optional

platform

string

optional

page

integer

optional

limit

integer

optional

total

integer

optional

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error