Get an SMTP config

GET

/v1/email/smtp/configs/{api_key_id}

curl -X GET "https://us1.platform.bird.com/v1/email/smtp/configs/{api_key_id}" \
  -H "Authorization: Bearer $TOKEN"

Returns the SMTP send-option config stored for the given API key. Returns a 404 if you haven't set a config for that key — the key still accepts SMTP submissions, using your organization's default pool, the transactional category, and tracking on.

Treść odpowiedzi

api_key_id

string

wymagane

ID of the API key this config applies to, the same key your SMTP client authenticates with. One config exists per key.

ip_pool_id

nullable string

ID of the IP pool that SMTP sends with this key use, or ipp_shared for the shared pool. null when this key uses your organization's default pool.

tags

array of object

wymagane

Structured {name, value} labels applied to every message submitted over SMTP with this key — the same tags used by the email sending API. See EmailMessageSendRequest for how tags are used for filtering and analytics.

Pokaż atrybuty podrzędne

tags.name

string

wymagane

Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.

tags.value

string

wymagane

Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.

track_opens

boolean

wymagane

Whether open events are tracked for messages submitted over SMTP with this key.

track_clicks

boolean

wymagane

Whether click events are tracked for messages submitted over SMTP with this key.

created_at

string

wymagane

updated_at

string

wymagane

curl -X GET "https://us1.platform.bird.com/v1/email/smtp/configs/{api_key_id}" \
  -H "Authorization: Bearer $TOKEN"