Domain

Download schema

Add sending domains, verify their DNS records, and control which projects are allowed to use them.

List all domains for the team

GET

https://api.lettermint.co/v1

/domains

Bearer

List all domains for the team › query Parameters

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

sort

string[]

Enum values:

domain

-domain

created_at

-created_at

status_changed_at

-status_changed_at

Default: ["-created_at"]

filter[project]

string

Filter by project ID

filter[status]

DomainStatus · enum


`verified` The domain is active and verified.
`partially_verified` Some DNS records of the domain could not be verified.
`pending_verification` The domain is new and verification is pending.
`failed_verification` The domain verification failed.

Enum values:

verified

partially_verified

pending_verification

failed_verification

filter[domain]

string

Search by domain name (partial match, case insensitive)

List all domains for the team › Responses

Paginated set of DomainListData

DomainListData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Create a new domain

POST

https://api.lettermint.co/v1

/domains

Bearer

Create a new domain › Request Body

StoreDomainData

domain

string · maxLength: 255 · pattern: ^(?!:\/\/)(?=.{1,255… · required

Create a new domain › Responses

DomainData

DomainData

id

string · required

domain

string · required

dkim_mode

DkimMode · enum · required

Enum values:

legacy_txt

managed_cname

rotation_ready

boolean · required

status_changed_at

string | null · date-time · required

created_at

string · date-time · required

DomainDnsRecordData[]

object[]

POST/domains

curl https://api.lettermint.co/v1/domains \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "domain": "domain"
}'

Example Request Body

{
  "domain": "domain"
}

json

Example Responses

{
  "id": "id",
  "domain": "domain",
  "dkim_mode": "legacy_txt",
  "rotation_ready": true,
  "status_changed_at": "2024-08-25T15:00:00Z",
  "dns_records": [
    {
      "id": "id",
      "type": "TXT",
      "hostname": "hostname",
      "fqdn": "fqdn",
      "content": "content",
      "status": "active",
      "purpose": "return_path",
      "verification_scope": "required",
      "required_for_verification": true,
      "verified_at": "verified_at",
      "last_checked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "projects": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get domain details

GET

https://api.lettermint.co/v1

/domains/{domainId}

Bearer

Get domain details › path Parameters

domainId

string · required

Get domain details › query Parameters

include

string[]

Enum values:

dnsRecords

projects

Get domain details › Responses

DomainData

DomainData

id

string · required

domain

string · required

dkim_mode

DkimMode · enum · required

Enum values:

legacy_txt

managed_cname

rotation_ready

boolean · required

status_changed_at

string | null · date-time · required

created_at

string · date-time · required

DomainDnsRecordData[]

object[]

GET/domains/{domainId}

curl https://api.lettermint.co/v1/domains/:domainId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "domain": "domain",
  "dkim_mode": "legacy_txt",
  "rotation_ready": true,
  "status_changed_at": "2024-08-25T15:00:00Z",
  "dns_records": [
    {
      "id": "id",
      "type": "TXT",
      "hostname": "hostname",
      "fqdn": "fqdn",
      "content": "content",
      "status": "active",
      "purpose": "return_path",
      "verification_scope": "required",
      "required_for_verification": true,
      "verified_at": "verified_at",
      "last_checked_at": "2024-08-25T15:00:00Z"
    }
  ],
  "projects": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a domain

DELETE

https://api.lettermint.co/v1

/domains/{domainId}

Bearer

Delete a domain › path Parameters

domainId

string · required

Delete a domain › Responses

Domain deleted

Confirmation that a request succeeded.

MessageResponse

message

string · required

Human-readable confirmation

Verify all DNS records for a domain

POST

https://api.lettermint.co/v1

/domains/{domainId}/dns-records/verify

Bearer

Verify all DNS records for a domain › path Parameters

domainId

string · required

Verify all DNS records for a domain › Responses

All required DNS records passed verification

All required DNS records of the domain passed verification.

DnsVerificationSuccessResponse

message

string · required

Human-readable verification result

DnsVerificationFailedRecord[] · required

Recommended records that did not pass verification. They do not block verification

Verify a specific DNS record

POST

https://api.lettermint.co/v1

/domains/{domainId}/dns-records/{recordId}/verify

Bearer

Verify a specific DNS record › path Parameters

domainId

string · required

recordId

string · required

Verify a specific DNS record › Responses

DNS record verified

Confirmation that a request succeeded.

MessageResponse

message

string · required

Human-readable confirmation

Update projects associated with a domain

PUT

https://api.lettermint.co/v1

/domains/{domainId}/projects

Bearer

Update projects associated with a domain › path Parameters

domainId

string · required

Update projects associated with a domain › Request Body

UpdateDomainProjectsData

project_ids

string[] · minItems: 1 · required

Update projects associated with a domain › Responses

Domain projects updated

The domain after a change, with a confirmation message.

DomainMutationResponse

DomainData · required

message

string · required

Human-readable confirmation

PUT/domains/{domainId}/projects

curl https://api.lettermint.co/v1/domains/:domainId/projects \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "project_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Example Request Body

{
  "project_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "data": {
    "id": "id",
    "domain": "domain",
    "dkim_mode": "legacy_txt",
    "rotation_ready": true,
    "status_changed_at": "2024-08-25T15:00:00Z",
    "dns_records": [
      {
        "id": "id",
        "type": "TXT",
        "hostname": "hostname",
        "fqdn": "fqdn",
        "content": "content",
        "status": "active",
        "purpose": "return_path",
        "verification_scope": "required",
        "required_for_verification": true,
        "verified_at": "verified_at",
        "last_checked_at": "2024-08-25T15:00:00Z"
      }
    ],
    "projects": [
      {
        "id": "id",
        "name": "name"
      }
    ],
    "created_at": "2024-08-25T15:00:00Z"
  },
  "message": "message"
}

json

application/json

Analytics Project