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.
Response Payload
api_key_id
string
required
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.
category
string
required
Content classification applied to messages submitted over SMTP with this key. Controls suppression policy: marketing blocks on all suppression reasons; transactional allows delivery through complaint and unsubscribe suppressions.
Possible values: marketing, transactional
tags
array of object
required
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.
Show child attributes
tags.name
string
required
Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
tags.value
string
required
Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
track_opens
boolean
required
Whether open events are tracked for messages submitted over SMTP with this key.
track_clicks
boolean
required
Whether click events are tracked for messages submitted over SMTP with this key.
created_at
string
required
updated_at
string
required