Skip to main content
GET
Get permitted sender choices

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-None-Match
string

Return 304 when this ETag still matches.

Query Parameters

delivery_group_id
string[]

Restrict choices to these delivery groups.

Maximum array length: 50
Required string length: 1 - 128
mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Current permitted choices.

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required