API referenceSenders
Add a sender
A from name and address on a verified sending domain. The workspace’s first sender is its default.
POST
A from name and address on a verified sending domain. The workspace’s first sender is its default.
idempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
Length
1 <= length <= 255application/json- body
fromName*stringLength
1 <= length <= 100localPart*stringMatch
^[a-z0-9](?:[a-z0-9._+-]{0,62}[a-z0-9])?$sendingDomainId*stringFormat
uuidreplyTo?|Format
emailisDefault?booleanCreated
application/json- response
id*stringFormat
uuidfromName*stringaddress*stringreplyTo*string|nullisDefault*booleansendingDomainId*stringFormat
uuidemailProviderId*stringFormat
uuiddomainStatus*stringValue in
"not_started""pending""verified""failed"createdAt*stringFormat
date-timecurl -X POST 'https://api.postforge.dev/v1/senders' \ -H 'Content-Type: application/json' \ -d '{ "fromName": "string", "localPart": "string", "sendingDomainId": "42ab023d-69c4-4d9b-b14e-a770c1291b5c"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fromName": "string", "address": "string", "replyTo": "string", "isDefault": true, "sendingDomainId": "42ab023d-69c4-4d9b-b14e-a770c1291b5c", "emailProviderId": "683bf648-54ce-4fc9-9f81-2da7d42459c3", "domainStatus": "not_started", "createdAt": "2019-08-24T14:15:22Z"}