- The parent domain must belong to the API key's workspace.
- Writes are supported only for Leadpush domains.
addressmust be the local part only, such assender, notsender@example.test.- Company address fields are required because they are used by the mail provider for sender registration.
Create Domain Address
Create a sender address for a Leadpush sending domain. Send only the local part in address; Leadpush combines it with the parent domain to create the full sender address.
Creation Behavior
What happens when a domain address is created
POST
/v1/domains/:domain/addressesCreate a sender address for a sending domain
Path parameters
domainstring Required Domain UUID
Request body
addressstring Required Local part of the sender address, such as `sender`
display_namestring Required Display name shown for the sender
reply_tostring Required Reply-to email address
company_addressstring Required Company street address
company_address_2stringOptional second company address line
company_citystring Required Company city
company_statestring Required Company state, province, or region
company_zipstring Required Company postal code
company_countrystring Required Company country
Errors
Common create failures
- The endpoint returns
404when the parent domain does not belong to the API key's workspace. - The endpoint returns
422whenaddresscontains@. - The endpoint returns
422when the parent domain is not a Leadpush domain.