API referenceSending Domains
Add a sending domain
Uses the domain when the account has it, or creates it there; the provider’s own open and click tracking is switched off (Postforge tracks). Answers the DNS records to set and what’s checked.
POST
Uses the domain when the account has it, or creates it there; the provider’s own open and click tracking is switched off (Postforge tracks). Answers the DNS records to set and what’s checked.
idempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
Length
1 <= length <= 255application/json- body
emailProviderId*stringFormat
uuidname*stringMatch
^(?=.{3,253}$)([a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$region?stringValue in
"us-east-1""eu-west-1""sa-east-1""ap-northeast-1"Created
application/json- response
id*stringFormat
uuidemailProviderId*stringFormat
uuidname*stringregion*|Value in
"us-east-1""eu-west-1""sa-east-1""ap-northeast-1"nullstatus*stringValue in
"not_started""pending""verified""failed"records*array<>dmarc*senderCount*integercheckedAt*|Format
date-timecreatedAt*stringFormat
date-timecurl -X POST 'https://api.postforge.dev/v1/sending-domains' \ -H 'Content-Type: application/json' \ -d '{ "emailProviderId": "683bf648-54ce-4fc9-9f81-2da7d42459c3", "name": "string"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "emailProviderId": "683bf648-54ce-4fc9-9f81-2da7d42459c3", "name": "string", "region": "us-east-1", "status": "not_started", "records": [ { "purpose": "string", "type": "string", "name": "string", "value": "string", "priority": 0, "status": "not_started" } ], "dmarc": { "status": "found", "record": "string", "host": "string", "suggested": "string" }, "senderCount": 0, "checkedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z"}