POST
/
api
/
v1
/
inbox
/
upsert

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email_address
string
required
id
string | null
required

The id of the inbox. If this is provided, the inbox will be updated. If this is not provided, a new inbox will be created

name
string
required
allow_bcc
boolean
default:
true

If true, emails that contain the inbox email address in the Bcc field will be marked valid

allow_cc
boolean
default:
true

If true, emails that contain the inbox email address in the Cc field will be marked valid

allowed_from_addresses
object | null

A list of addresses and domains that are allowed to send emails to the inbox. If the field is null, or the addresses and domains fields are both empty lists, all from addresses are allowed

blocked_from_addresses
object | null

A list of addresses and domains that are blocked from sending emails to the inbox. If the field is null, or the addresses and domains fields are both empty lists, all from addresses are allowed

dkim_pass_required
boolean
default:
true

If true, emails need to pass the DKIM check to be marked valid. See here for more information on DKIM

dmarc_pass_required
boolean
default:
true

If true, emails need to pass the DMARC check to be marked valid. See here for more information on DMARC

open_and_click_tracking
boolean
default:
false

If true, open and click tracking will be enabled for all emails sent from the inbox

spf_pass_required
boolean
default:
true

If true, emails need to pass the SPF check to be marked valid. See here for more information on SPF

webhook_signing_secret_id
string | null

The id of the webhook signing secret to use for the webhook. Only relevant if a webhook_url is provided. If not provided, an existing signing secret will be assigned, or if no signing secret exists, a new one will be created and assigned

webhook_url
string | null

The url to send webhooks to when an email is received by the inbox

Response

200 - application/json
id
string
required
webhook_secret
string | null

The signing secret to use for the webhook when a webhook_url is provided. This secret will only be returned once, make sure to save it in a secure location

webhook_signing_secret_id
string | null

The id of the signing secret to use for the webhook when a webhook_url is provided.