email-smtp-configs

Get an SMTP config

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

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

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/smtp/configs/{api_key_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

SMTP config object.

api_key_idstring required
ip_pool_idstring nullable

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'marketing' | 'transactional' 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.
track_opensboolean required

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

track_clicksboolean required

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

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "api_key_id": "key_01krdgeqcxet5s7t44vh8rt9mg",
  "tags": [
    {
      "name": "category",
      "value": "welcome"
    }
  ],
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.