Verified Senders API — Add, Verify, and Manage Senders

Authentication

All endpoints accept either an ApiKey header or an OAuth header. See the OAuth Endpoints page for token generation.

Get Senders

Returns all verified senders associated with your account, along with their DNS validation statuses. Optionally filter to a single sender address.

Request Body

string

Filter results to a specific sender address. Omit this field (or pass an empty object) to retrieve all senders.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

array[object]

Array of verified sender records.

Show sender object

string

The sender email address (e.g. noreply@yourdomain.com).

integer

MX record validation status. 1 = valid, 0 = invalid or unverified.

integer

SPF record validation status. 1 = valid, 0 = invalid or unverified.

integer

DKIM record validation status. 1 = valid, 0 = invalid or unverified.

integer

DMARC record validation status. 1 = valid, 0 = invalid or unverified.

integer

Overall validation flag. 1 = fully validated, 0 = pending or failed.

integer

1 if the domain is an EffiLink-managed domain; 0 if it is a custom domain.

integer

1 = Marketing sender; 2 = Transactional sender.

curl --request POST \
  --url https://api.effilink.co/v5/verified_senders/get \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{}'

Response

{
  "code": 200,
  "message": "",
  "mailFromDomains": [
    {
      "fromDomain": "noreply@yourdomain.com",
      "mxStatus": 1,
      "spfStatus": 1,
      "dkimStatus": 1,
      "dmarcStatus": 1,
      "isValidate": 1,
      "isYiyeDomain": 0,
      "senderType": 2
    }
  ]
}

Add Sender

Registers a new sender email address for domain verification. The address must belong to a subdomain or non-top-level domain (e.g. noreply@mail.yourdomain.com).

Request Body

string

required

The sender email address to register. Must be a non-top-level domain address (e.g. noreply@yourdomain.com).

string

required

The intended use of this sender:

"1" — Marketing emails.
"2" — Transactional emails.

boolean

When true, the operation is simulated and no sender is registered.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

curl --request POST \
  --url https://api.effilink.co/v5/verified_senders/add \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "senderEmail": "noreply@yourdomain.com",
    "senderType": "2"
  }'

Response

{
  "code": 200,
  "message": ""
}

Verify Sender Domain

Triggers a live DNS lookup to validate the MX, SPF, DKIM, and DMARC records for a registered sender address.

Request Body

string

required

The sender address whose domain DNS records should be verified.

string

required

The DKIM selector string used when EffiLink published the DKIM public key for your domain (e.g. effilink2024).

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

boolean

true if all required DNS records passed validation.

boolean

true if the MX record is correctly configured.

boolean

true if the SPF record is correctly configured.

boolean

true if the DKIM record is correctly configured for the given selector.

boolean

true if the DMARC record is correctly configured.

curl --request POST \
  --url https://api.effilink.co/v5/verified_senders/verify \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "fromDomain": "noreply@yourdomain.com",
    "selector": "effilink2024"
  }'

Response

{
  "code": 200,
  "message": "",
  "valid": true,
  "goodMX": true,
  "goodSPF": true,
  "goodDKIM": true,
  "goodDMARC": true
}

Delete Sender

Removes a verified sender address from your account. Emails already in transit are not affected.

Request Body

string

required

The sender email address to remove.

boolean

When true, the operation is simulated and no sender is deleted.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

Response

{
  "code": 200,
  "message": ""
}

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

Verified Senders API — Add, Verify, and Manage Senders

Authentication

Get Senders

Request Body

Response

Add Sender

Request Body

Response

Verify Sender Domain

Request Body

Response

Delete Sender

Request Body

Response

​Authentication

​Get Senders

​Request Body

​Response

​Add Sender

​Request Body

​Response

​Verify Sender Domain

​Request Body

​Response

​Delete Sender

​Request Body

​Response

Authentication

Get Senders

Request Body

Response

Add Sender

Request Body

Response

Verify Sender Domain

Request Body

Response

Delete Sender

Request Body

Response