POST
/
api
/
v1
/
inbox
/
upsert

Authorizations

Authorization
string
headerrequired

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

Body

application/json
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
email_address
string
required
allow_cc
boolean
default: true

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

allow_bcc
boolean
default: true

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

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

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

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

webhook_url
string | null

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

webhook_authentication_type
enum<string> | null

The type of authentication to use for the webhook. Must be provided if webhook_url is provided. See here for more information

Available options:
signing_secret,
bearer_token
webhook_secret
string | null

The secret to use for the webhook. This is only valid when webhook_authentication_type is bearer_token

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 and the webhook_authentication_type is signing_secret. This secret will only be returned once, make sure to save it in a secure location

webhook_secret_preview
string | null
Get InboxesGet Domains