emails

Inboxes hang off an identity, on a verified domain. Five methods. API detail: Email & SMS.

create

client.emails.create(identityId: string, body: InboxCreate): Promise<EmailInbox>

POST /v1/identities/{id}/emails. InboxCreate is one of two shapes:

{ address: "billing@acme.com", owning_agent_id: "agt_..." }   // exact address on a verified domain
{ domain_id: "dom_...", owning_agent_id: "agt_..." }          // let the server mint the address

list

client.emails.list(identityId: string, query?: { limit?: number }): Promise<Page<EmailInbox>>

GET /v1/identities/{id}/emails.

delete

client.emails.delete(identityId: string, inboxId: string): Promise<Deleted>

DELETE /v1/identities/{id}/emails/{inbox_id}.

send

client.emails.send(identityId: string, inboxId: string, body: EmailSend): Promise<EmailSendReceipt>

POST /v1/identities/{id}/emails/{inbox_id}/send. EmailSend is { to: string[], subject, text }. Answers 202 with a receipt — { accepted, from, to, sent_at }; the provider’s message id is deliberately absent. Sending is gated on the domain’s dns_status; a premature send is a retryable job_not_ready.

messages

client.emails.messages(identityId: string, query?: { channel?: "email" | "sms"; limit?: number }): Promise<Page<InboundMessage>>

GET /v1/identities/{id}/messages — everything that arrived for the persona, both channels unless one is named. The same feed as identities.messages.

TypeScript

Control plane

Resources

Identity & access

Automation

Account

create

list

delete

send

messages

​create

​list

​delete

​send

​messages

create

list

delete

send

messages