Skip to content

Start SES domain verification (DNS readiness is checked client-side via checkDomainDns)

POST
/domains/{sender}/start-verification
 
curl --request POST \
  --url https://api.pingram.io/domains/example/start-verification \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
sender
required
string

Sender domain (URL encoded)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Media type application/json
Array<object>
object
sender
required
string
status
required
string
Allowed values: SUCCESS PENDING FAILED TEMPORARY_FAILURE NOT_STARTED
lastSync
required
string format: date-time
verificationTokens
Array<string>
mailFromDomainStatus
string
Allowed values: PENDING SUCCESS FAILED TEMPORARY_FAILURE
createdAt
required
string
privateDKIMKey
string
reminderSentAt
string
selector
required
string
Example 
[
  {
    "status": "SUCCESS",
    "mailFromDomainStatus": "PENDING"
  }
]

400

Section titled “400 ”

Bad Request - validation errors, invalid input

Media type application/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Example generated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Section titled “401 ”

Unauthorized

402

Section titled “402 ”

Payment Required - usage limits exceeded

Media type application/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Example generated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Section titled “500 ”

Internal Server Error

502

Section titled “502 ”

Bad Gateway - provider error

Media type application/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Example generated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}