Create Domain Address

Creation Behavior

What happens when a domain address is created

  • The parent domain must belong to the API key's workspace.
  • Writes are supported only for Leadpush domains.
  • address must be the local part only, such as sender, not sender@example.test.
  • Company address fields are required because they are used by the mail provider for sender registration.
POST
/v1/domains/:domain/addresses

Create 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_2string

Optional 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

Create Domain Address
curl -X POST https://api.leadpush.io/v1/domains/:domain/addresses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}" \
-d '{
  "address": "sender",
  "display_name": "Sender Name",
  "reply_to": "reply@example.test",
  "company_address": "123 Main St",
  "company_address_2": null,
  "company_city": "New York",
  "company_state": "NY",
  "company_zip": "10001",
  "company_country": "US"
}'
Response Example
{
"data": {
  "uuid": "<address_uuid>",
  "domain_uuid": "<domain_uuid>",
  "address": "sender",
  "full_address": "sender@example.test",
  "provider": "leadpush",
  "display_name": "Sender Name",
  "verification": "completed",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "created_at": "2021-01-01T00:00:00.000Z"
}
}

Errors

Common create failures

  • The endpoint returns 404 when the parent domain does not belong to the API key's workspace.
  • The endpoint returns 422 when address contains @.
  • The endpoint returns 422 when the parent domain is not a Leadpush domain.