Pular para o conteúdo

POST /v1/email/domains

POST
/v1/email/domains
curl --request POST \
--url https://seu-endereco-da-api/v1/email/domains \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "domain": "example" }'

Permissão que a Chave de acesso precisa: Gerenciar a Central de apps (integrations:manage).

Media typeapplication/json
object
domain
required
string
>= 1 characters <= 253 characters

Example generated

{
"domain": "example"
}
Media typeapplication/json
object
id
required
string
domain
required
string
status
required
string
Allowed values: pending verified disconnecting
dnsRecords
required

The records the customer publishes at their DNS provider

Array<object>
object
key
required

Provider’s name for the record: mail_cname, dkim1 or dkim2

string
host
required
string
type
required
string
Allowed values: CNAME TXT MX
data
required
string
valid
required

True once the record resolves to the expected value

boolean
verifiedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time

Example

{
"status": "pending",
"dnsRecords": [
{
"type": "CNAME"
}
]
}

The domain is already connected

The e-mail provider refused the domain