Skip to main content

1. Create a workspace and API key

Sign in to the dashboard and create or select a workspace. In API keys, create a key with workspace-wide resource access and these scopes:
  • inboxes:write to create an inbox.
  • inboxes:read to read messages.
  • email:send to send and reply.
Save the key in your server environment:
Check the connection:
The response identifies your workspace, scopes, resource access, and remaining daily allowances.

2. Create an inbox

Choose an available username. The response includes the inbox id and full email address.
Set the returned ID:
If your workspace requires approval, an owner or admin must approve the request in Approvals. Then repeat it unchanged.

3. Send an email

Replace the recipient with an address you control. Keep the same idempotency key if you retry this exact send; use a new key for a different message.
The response includes an operation ID and statusUrl. Poll that URL with the same credential if the status is pending or unknown. completed means the provider accepted the message; delivery is tracked separately.

4. Read the reply

Reply from your own mailbox, then list messages:
Lists contain summaries. Fetch the full content using a returned message ID:
Next: reply to a message, use an SDK, or subscribe to webhooks.