<Intro>

<EndpointHeader />

<Description>

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.

</Description>

</Intro>

<Payload kind="response">

<Field name="api_key_id" type="string" required>

<Description>

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

</Description>

</Field>

<Field name="ip_pool_id" type="nullable string">

<Description>

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.

</Description>

</Field>

<Field name="category" type="string" required>

<Description>

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.

</Description>

<Description>

Possible values: `marketing`, `transactional`

</Description>

</Field>

<Field name="tags" type="array of object" required>

<Description>

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.

</Description>

<FieldChildren kind="response">

<Field name="name" type="string" prefix="tags." required>

<Description>

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

</Description>

</Field>

<Field name="value" type="string" prefix="tags." required>

<Description>

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

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="track_opens" type="boolean" required>

<Description>

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

</Description>

</Field>

<Field name="track_clicks" type="boolean" required>

<Description>

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

</Description>

</Field>

<Field name="created_at" type="string" required />

<Field name="updated_at" type="string" required />

</Payload>