AI Inbx API

Email infrastructure for software that holds conversations: send, receive, thread and reply over one REST API, with a webhook for every event.

Spaces

Group a workspace’s domains, mailboxes and mail by customer. Optional: a workspace that is not a platform never needs one.

• GET
  List spaces/spaces
• POST
  Create a space/spaces
• GET
  Retrieve a space/spaces/{space_id}
• DELETE
  Delete a space/spaces/{space_id}
• PATCH
  Update a space/spaces/{space_id}

API Keys

Create and delete credentials for API access.

• GET
  List API keys/api-keys
• POST
  Create an API key/api-keys
• DELETE
  Delete an API key/api-keys/{key_id}

Emails

Send, inspect, and schedule email.

• GET
  List emails/emails
• POST
  Send an email/emails
• GET
  Retrieve an email/emails/{email_id}
• PATCH
  Update an email/emails/{email_id}
• POST
  Send a draft/emails/{email_id}/send
• POST
  Cancel an email/emails/{email_id}/cancel

Threads

Read email conversations.

• GET
  List threads/threads
• GET
  Retrieve a thread/threads/{thread_id}
• POST
  Reply in a thread/threads/{thread_id}/reply
• POST
  Forward a thread/threads/{thread_id}/forward

Attachments

Download original and prepared attachment content.

• GET
  Download an attachment/attachments/{attachment_id}
• HEAD
  Inspect attachment metadata/attachments/{attachment_id}
• GET
  Download prepared attachment text/attachments/{attachment_id}/content

Domains

Manage sending domains and DNS checks.

• GET
  List domains/domains
• POST
  Create a domain/domains
• GET
  Retrieve a domain/domains/{domain_id}
• DELETE
  Delete a domain/domains/{domain_id}
• PATCH
  Update domain tracking settings/domains/{domain_id}
• POST
  Verify domain DNS records now/domains/{domain_id}/verify
• GET
  Diagnose domain DNS configuration/domains/{domain_id}/diagnostics

Mailboxes

Connect and manage provider mailboxes.

• GET
  List mailboxes/mailboxes
• POST
  Create a mailbox connection URL/mailboxes/connect
• GET
  Retrieve a mailbox/mailboxes/{mailbox_id}
• DELETE
  Disconnect a mailbox/mailboxes/{mailbox_id}
• POST
  Queue a mailbox sync/mailboxes/{mailbox_id}/sync

OAuth Apps

Manage customer-owned Google and Microsoft OAuth apps.

• GET
  List OAuth apps/oauth-apps
• POST
  Create an OAuth app/oauth-apps
• GET
  Retrieve an OAuth app/oauth-apps/{app_id}
• DELETE
  Delete an OAuth app/oauth-apps/{app_id}
• PATCH
  Update an OAuth app/oauth-apps/{app_id}

Webhooks

Configure event delivery and inspect delivery attempts.

• GET
  List webhook endpoints/webhook-endpoints
• POST
  Create a webhook endpoint/webhook-endpoints
• GET
  Retrieve a webhook endpoint/webhook-endpoints/{endpoint_id}
• DELETE
  Delete a webhook endpoint/webhook-endpoints/{endpoint_id}
• PATCH
  Update a webhook endpoint/webhook-endpoints/{endpoint_id}
• POST
  Rotate a webhook signing secret/webhook-endpoints/{endpoint_id}/rotate-secret
• POST
  Send a test webhook/webhook-endpoints/{endpoint_id}/test
• GET
  List webhook deliveries/webhook-endpoints/{endpoint_id}/deliveries
• POST
  Retry webhook deliveries/webhook-endpoints/{endpoint_id}/deliveries/retry

Events

Read back what happened in the workspace — the events webhooks carry, whether or not an endpoint heard them.

• GET
  List events/events
• GET
  Retrieve an event/events/{event_id}

Webhook events

What an endpoint receives: one request per event, each signed, in the envelope every event shares.

• POST
  email.receivedemail.received
• POST
  email.sentemail.sent
• POST
  email.deliveredemail.delivered
• POST
  email.bouncedemail.bounced
• POST
  email.complainedemail.complained
• POST
  email.failedemail.failed
• POST
  email.unsubscribedemail.unsubscribed
• POST
  email.openedemail.opened
• POST
  email.clickedemail.clicked
• POST
  thread.createdthread.created
• POST
  domain.verifieddomain.verified
• POST
  domain.lostdomain.lost
• POST
  mailbox.connectedmailbox.connected
• POST
  mailbox.needs_reauthmailbox.needs_reauth
• POST
  mailbox.disconnectedmailbox.disconnected

Suppressions

Prevent delivery to opted-out or unsafe recipients.

• GET
  List suppressions/suppressions
• POST
  Create suppressions/suppressions
• GET
  Retrieve a suppression/suppressions/{suppression_id}
• DELETE
  Delete a suppression/suppressions/{suppression_id}

Pacing

Control send rate, hours, and queue flow.

• GET
  List pacing rules/pacing-rules
• POST
  Create a pacing rule/pacing-rules
• GET
  Retrieve a pacing rule/pacing-rules/{rule_id}
• DELETE
  Delete a pacing rule/pacing-rules/{rule_id}
• PATCH
  Update a pacing rule/pacing-rules/{rule_id}
• GET
  Retrieve pacing spread/pacing-rules/spread
• PATCH
  Update pacing spread/pacing-rules/spread
• GET
  Retrieve the pacing queue/pacing-queue
• POST
  Release emails from the pacing queue/pacing-queue/release

Workspace

The workspace a request acts in: its name, and the defaults new domains start with.

• GET
  List workspaces/workspaces
• GET
  Retrieve the workspace/workspace
• PATCH
  Update the workspace/workspace

Members

Who is in the workspace, what each of them may do, and the invitations waiting to be accepted. Admin only.

• GET
  List members/members
• DELETE
  Remove a member/members/{member_id}
• PATCH
  Update a member/members/{member_id}
• GET
  List invitations/invitations
• POST
  Invite someone/invitations
• DELETE
  Cancel an invitation/invitations/{invitation_id}