Sign in to fill these examples with your own keys. Sign in Start free trial

DKIM signing

Whether the primary domain also signs mail from the team's other domains.

Every message is signed with the DKIM key of the domain it is sent from. By default, mail from the team's other domains also gets a second signature from the primary domain. Set sign_with_primary_domain to false to sign each message only with its own domain. The primary domain can still appear in the From header either way. Only a key created by a Team Administrator can read or change it. Other keys get 404.

GET /api/v1/teams/:obfuscated_team_id/dkim_signing

Get the team's DKIM signing setting and its primary domain.

request.sh
1curl -sS -X GET \ 2 -H 'Authorization: Bearer YOUR_API_KEY' \ 3 https://app.postshiba.com/api/v1/teams/KjkAJW/dkim_signing
response.json
1{ 2 "sign_with_primary_domain": true, 3 "primary_domain": "mail.example.com" 4}

PATCH /api/v1/teams/:obfuscated_team_id/dkim_signing

Set sign_with_primary_domain to true or false. Any other value returns 422.

request.sh
1curl -sS -X PATCH \ 2 -H 'Authorization: Bearer YOUR_API_KEY' \ 3 -H 'Content-Type: application/json' \ 4 -d '{"team":{"sign_with_primary_domain":false}}' \ 5 https://app.postshiba.com/api/v1/teams/KjkAJW/dkim_signing
response.json
1{ 2 "sign_with_primary_domain": false, 3 "primary_domain": "mail.example.com" 4}