Skip to content

Conversation

@rosadajake
Copy link
Contributor

@rosadajake rosadajake commented Jan 13, 2026

Screenshot 2026-01-13 at 1 36 48 PM Screenshot 2026-01-13 at 1 36 57 PM Screenshot 2026-01-13 at 1 37 07 PM Screenshot 2026-01-13 at 1 37 15 PM Screenshot 2026-01-13 at 1 37 45 PM Screenshot 2026-01-13 at 1 38 34 PM Screenshot 2026-01-13 at 1 38 46 PM

Pull Request Summary

DKIM Keys API Documentation

Added comprehensive documentation for the new DKIM Keys API endpoints, allowing customers to manage multiple DKIM keys per sending domain.

Changes to content/api/sending-domains.apib

Added a new DKIM Keys section including:

  • DKIM Key Object - Field definitions and sample JSON
  • DKIM Key Constraints - Limits table (max 256 keys per domain, ID format rules, etc.)
  • DNS Verification Requirements - TXT record format and verification requirements
  • DKIM Key Error Codes - Comprehensive error codes table with HTTP statuses and descriptions
  • 6 new endpoints:
    • GET /v1/sending-domains/{domain}/dkim-keys - List all DKIM keys
    • POST /v1/sending-domains/{domain}/dkim-keys - Create a DKIM key (auto-generate or user-provided)
    • GET /v1/sending-domains/{domain}/dkim-keys/{key_id} - Retrieve a specific DKIM key
    • PUT /v1/sending-domains/{domain}/dkim-keys/{key_id} - Update a DKIM key
    • DELETE /v1/sending-domains/{domain}/dkim-keys/{key_id} - Delete a DKIM key
    • POST /v1/sending-domains/{domain}/dkim-keys/{key_id}/verify - Verify a DKIM key's DNS record

Changes to content/api/transmissions.apib

  • Added options.dkim_key field to select which DKIM key to use for signing
  • Added error responses for invalid/unverified DKIM key scenarios
  • Updated sample JSON to include dkim_key example

Changes to content/api/smtp.apib

  • Added options.dkim_key field to the X-MSYS-API header options
  • Updated X-MSYS-API example JSON to include dkim_key

Note

Introduces documentation for managing multiple DKIM keys per sending domain and how to select them when sending.

  • New DKIM Keys section in sending-domains.apib: object schema, constraints, DNS verification requirements, error codes, and endpoints: GET/POST /sending-domains/{domain}/dkim-keys, GET/PUT/DELETE /{key_id}, POST /{key_id}/verify
  • Transmissions & SMTP: add options.dkim_key to select a verified key; update examples and add 400 error cases for invalid/unverified keys
  • Minor: remove Enterprise-only note from dkim.signing_domain in create/update domain data structures

Written by Cursor Bugbot for commit ee054b8. This will update automatically on new commits. Configure here.

@rosadajake rosadajake merged commit 169382f into main Jan 22, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants