API referenceSending Domains
Get a sending domain
GET
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringFormat
uuidOK
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 GET 'https://api.postforge.dev/v1/sending-domains/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "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"}Add a sending domain 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.
Remove a sending domain DELETE
Stops sending from it in this workspace; the domain stays in the provider’s account. Refused while senders use it.