Skip to main content
DELETE
Delete a custom domain

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

id
string
required

The id identifier.

Response

200 - application/json

Returns the deleted email domain.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
email_domain
domain
string
required

The custom domain name.

records
object[]
required

DNS records that must be added at the domain’s DNS provider.

status
enum<string>
required

Whether the domain has been verified.

Available options:
pending,
verified,
failed
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.