Email

Create an inbox

Creates a named inbox. With a verified email domain the address is {local_part}@yourdomain.com; without one it lands on the shared Crevio domain as {slug}.{local_part}@ai.crevio.app, which receives immediately and sends as the account's default outbound address. On the shared domain local_part must be one word of lowercase letters, numbers, hyphens or underscores, and an account can hold up to 20 such inboxes. Creating an address that already exists returns that inbox.

post/email/inboxes

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/email/inboxes
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Request body

local_partstring required

The name before the @, e.g. invoices. Prefixed with the account slug on the shared Crevio domain.

display_namestring
metadataobject
client_idstring

Response

Created

objectstring required
idstring required
addressstring required
local_partstring required
domainstring nullable required
display_namestring nullable required
status'active' | 'deleted' required
metadataobject required
created_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.