Skip to main content
PATCH
/
api
/
v1
/
accounts
/
{accountId}
/
email-domains
/
{id}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2023-01-01T00:00:00Z",
  "modifiedAt": "2023-01-01T00:00:00Z",
  "domain": "vortexsoftware.com",
  "description": "Email domain for Vortex Software",
  "verificationToken": "verification-token-123",
  "tokenVerificationRequestedAt": "2023-01-01T00:00:00Z",
  "tokenVerificationCompletedAt": "2023-01-01T00:00:00Z",
  "tokenVerificationStatus": "waiting_for_provider",
  "tokenVerificationError": {},
  "tokenVerificationAttempts": 0,
  "dkimTokens": {
    "dkim": "dkim-token-123"
  },
  "isVerified": false,
  "dkimStatus": "waiting_for_user",
  "dkimError": {},
  "dkimAttempts": 0,
  "dkimRequestedAt": "2023-01-01T00:00:00Z",
  "dkimCompletedAt": "2023-01-01T00:00:00Z",
  "spfCheckStatus": "waiting_for_user",
  "spfCheckError": {},
  "spfCheckAttempts": 0,
  "spfCheckRequestedAt": "2023-01-01T00:00:00Z",
  "spfCheckCompletedAt": "2023-01-01T00:00:00Z",
  "dmarcStatus": "waiting_for_user",
  "dmarcError": {},
  "dmarcAttempts": 0,
  "dmarcRequestedAt": "2023-01-01T00:00:00Z",
  "dmarcCompletedAt": "2023-01-01T00:00:00Z",
  "isDefault": false,
  "deactivated": false,
  "attributes": {}
}

Path Parameters

​
accountId
string
required

The ID of the account

​
id
string
required

The ID of the email domain

Body

application/json
​
description
string | null
required
Example:

"Email domain for Vortex Software"

Response

​
id
string
required

The unique identifier of the email domain.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
organizationId
string
required

The unique identifier of the organization.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
accountId
string
required

The unique identifier of the account.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
creatorId
string
required

The unique identifier of the creator.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
createdAt
string<date-time>
required

The date and time when the email domain was created.

Example:

"2023-01-01T00:00:00Z"

​
modifiedAt
string<date-time> | null
required

The date and time when the email domain was last modified.

Example:

"2023-01-01T00:00:00Z"

​
domain
string
required

The email domain.

Example:

"vortexsoftware.com"

​
description
string | null
required

A description of the email domain.

Example:

"Email domain for Vortex Software"

​
verificationToken
string | null
required

Token used for email domain verification. You must make a TXT record with this token in your DNS settings.

Example:

"verification-token-123"

​
tokenVerificationRequestedAt
string<date-time> | null
required

The date and time when the verification token was requested.

Example:

"2023-01-01T00:00:00Z"

​
tokenVerificationCompletedAt
string<date-time> | null
required

The date and time when the verification token was completed.

Example:

"2023-01-01T00:00:00Z"

​
tokenVerificationStatus
enum<string>
default:waiting_for_provider
required

The current status of the verification token.

Available options:
waiting_for_user,
waiting_for_provider,
verified,
provider_failed,
failed
​
tokenVerificationError
object | null
required

Error information related to the verification token.

​
tokenVerificationAttempts
number
required

The number of attempts made to verify the token.

Example:

0

​
dkimTokens
object | null
required

DKIM tokens for the email domain.

Example:
{ "dkim": "dkim-token-123" }
​
isVerified
boolean
required

Indicates whether the email domain is verified.

Example:

false

​
dkimStatus
enum<string> | null
required

The current status of the DKIM verification process.

Available options:
waiting_for_provider,
waiting_for_user,
verified,
provider_failed,
failed
Example:

"waiting_for_user"

​
dkimError
object | null
required

Error information related to DKIM verification.

​
dkimAttempts
number
required

The number of attempts made to verify DKIM.

Example:

0

​
dkimRequestedAt
string<date-time> | null
required
Example:

"2023-01-01T00:00:00Z"

​
dkimCompletedAt
string<date-time> | null
required
Example:

"2023-01-01T00:00:00Z"

​
spfCheckStatus
enum<string> | null
required

The current status of the SPF check.

Available options:
waiting_for_user,
verified,
failed
Example:

"waiting_for_user"

​
spfCheckError
object | null
required
​
spfCheckAttempts
number
required
Example:

0

​
spfCheckRequestedAt
string<date-time> | null
required
Example:

"2023-01-01T00:00:00Z"

​
spfCheckCompletedAt
string<date-time> | null
required
Example:

"2023-01-01T00:00:00Z"

​
dmarcStatus
enum<string> | null
required

The current status of the DMARC check.

Available options:
waiting_for_user,
verified,
failed
Example:

"waiting_for_user"

​
dmarcError
object | null
required

Error information related to DMARC verification.

​
dmarcAttempts
number
required

The number of attempts made to verify DMARC.

Example:

0

​
dmarcRequestedAt
string<date-time> | null
required
Example:

"2023-01-01T00:00:00Z"

​
dmarcCompletedAt
string<date-time> | null
required
Example:

"2023-01-01T00:00:00Z"

​
isDefault
boolean
required
Example:

false

​
deactivated
boolean
required
Example:

false

​
attributes
object | null
required