Allowlist an inbox sender

Changed on

Allow an email address or a whole domain to send bills to the inbox. Public email domains such as gmail.com can't be allowed as a domain.

post/v2/bills/inbox/senders

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/bills/inbox/senders
  • Auth
    API key in header X-API-Key

Request body

type'email' | 'domain' required

email to allowlist one address, domain to allowlist every address at a domain.

valuestring required

The address (billing@vendor.com) or bare domain (vendor.com), matched case-insensitively. Public mail providers such as gmail.com cannot be allowlisted as a domain; add the individual address instead.

Example request

{
  "value": "billing@vendor.com"
}

Response

The allowlisted sender.

idstring required

Sender id with the ais_ prefix. Remove the sender with DELETE /v2/bills/inbox/senders/{senderId}.

type'email' | 'domain' required

email matches one address exactly; domain matches every address at that domain.

valuestring required

The lowercased address or bare domain.

createdAtstring date-time required

When the sender was allowlisted.

Example response

{
  "id": "ais_2rj4l7hmrrrcv",
  "value": "billing@vendor.com"
}

Changes