Skip to main content

​
Create Inbox

curl -X POST https://api.sendook.com/v1/inboxes \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support Inbox",
    "email": "[email protected]"
  }'
Create a new inbox for receiving and sending emails.

​
Request Body

​
name
string
A friendly name for the inbox. Used as the display name when sending emails.Example: "Support Inbox"
​
email
string
The email address for the inbox. If not provided, a random email address will be generated using the default domain.Important: Custom domains must be verified before use. If using a custom domain, ensure it’s added and verified in your account first.Example: "[email protected]"

​
Response

​
id
string
Unique identifier for the inbox.
​
organizationId
string
ID of the organization that owns this inbox.
​
domainId
string
ID of the custom domain associated with this inbox (if using a custom domain).
​
name
string
The friendly name of the inbox.
​
email
string
The email address of the inbox.
​
createdAt
string
ISO 8601 timestamp of when the inbox was created.
​
updatedAt
string
ISO 8601 timestamp of when the inbox was last updated.

​
Error Responses

​
error
string
Error message describing what went wrong.
400 Bad Request - Invalid request parameters
  • "Invalid email address" - The email format is invalid
  • "Inbox with this email already exists" - An inbox with this email already exists
404 Not Found - Resource not found
  • "Invalid domain name" - The custom domain doesn’t exist or isn’t verified

​
List Inboxes

curl https://api.sendook.com/v1/inboxes \
  -H "Authorization: Bearer YOUR_API_KEY"
Retrieve all inboxes for your organization.

​
Response

Returns an array of inbox objects. Each inbox object contains:
​
id
string
Unique identifier for the inbox.
​
organizationId
string
ID of the organization that owns this inbox.
​
domainId
string
ID of the custom domain associated with this inbox (if applicable).
​
name
string
The friendly name of the inbox.
​
email
string
The email address of the inbox.
​
createdAt
string
ISO 8601 timestamp of when the inbox was created.
​
updatedAt
string
ISO 8601 timestamp of when the inbox was last updated.

​
Get Inbox

curl https://api.sendook.com/v1/inboxes/inbox_123 \
  -H "Authorization: Bearer YOUR_API_KEY"
Retrieve a specific inbox by its ID.

​
Path Parameters

​
inboxId
string
required
The unique identifier of the inbox to retrieve.

​
Response

​
id
string
Unique identifier for the inbox.
​
organizationId
string
ID of the organization that owns this inbox.
​
domainId
string
ID of the custom domain associated with this inbox (if applicable).
​
name
string
The friendly name of the inbox.
​
email
string
The email address of the inbox.
​
createdAt
string
ISO 8601 timestamp of when the inbox was created.
​
updatedAt
string
ISO 8601 timestamp of when the inbox was last updated.

​
Error Responses

404 Not Found
  • "Inbox not found" - The inbox doesn’t exist or doesn’t belong to your organization

​
Delete Inbox

curl -X DELETE https://api.sendook.com/v1/inboxes/inbox_123 \
  -H "Authorization: Bearer YOUR_API_KEY"
Delete an inbox and all its associated messages.
This action is permanent and cannot be undone. All messages in the inbox will be deleted.

​
Path Parameters

​
inboxId
string
required
The unique identifier of the inbox to delete.

​
Response

Returns the deleted inbox object.
​
id
string
Unique identifier for the deleted inbox.
​
organizationId
string
ID of the organization that owned this inbox.
​
domainId
string
ID of the custom domain associated with this inbox (if applicable).
​
name
string
The friendly name of the inbox.
​
email
string
The email address of the inbox.
​
createdAt
string
ISO 8601 timestamp of when the inbox was created.
​
updatedAt
string
ISO 8601 timestamp of when the inbox was last updated.

​
Error Responses

404 Not Found
  • "Inbox not found" - The inbox doesn’t exist or doesn’t belong to your organization

​
Webhook Events

Deleting an inbox triggers the following webhook events:
  • inbox.deleted - Fired when the inbox is successfully deleted

Build docs developers (and LLMs) love

Get started for freeTalk to us