Create and manage Approved Senders using the API.

REST Methods

Note: API is case sensitive. Make all parameters entries lower case. All parameters in red are required.

Note: Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API. If a subsequent read request fails to reflect your changes, please wait a few minutes and try again.

VERB RESOURCE PARAMETERS DESCRIPTION
GET /senders
  • apikey
  • startindex
Retrieves a list of up to 25 Email Sub-Accounts.
GET /senders/details
  • apikey
  • emailaddress
Retrieves a list of details on the specified approved sender.
GET /senders/status
  • apikey
  • emailaddress
Retrieves the status of an approved sender.
POST /senders
  • apikey
  • emailaddress
  • seeding
Create or update an Approved Sender account.
POST /senders/dkim
  • apikey
  • emailaddress
  • dkim
Defines an Approved Sender’s DKIM Selector.
POST /senders/delete
  • apikey
  • emailaddress
Deletes the defined Approved Sender.

 


GET /senders

Retrieves a list of approved senders from your master account.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • startindex — A starting index of where to begin the list approved senders.
    Valid values:
    [any positive integer] = The integer will relate to the first approved sender on the return list. For instance, a start index of 25 will return the next 25 (25 – 49) senders.
    0 = Default. Returns first 25 approved senders. Accounts with more than 25 approved senders will only receive the first 25 if no startindex is entered.

Example Request

curl --request GET "https://emailapi.dynect.net/rest/json/senders?apikey=ABC123XYZ"

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"senders":[{"emailaddress":"email1@domain.org"},{"emailaddress":"email2@domain.org"},…]}}

GET /senders/details

Retrieves a list of details on the specified approved sender.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • emailaddressRequired. Approved Sender’s Email Address.

Example Request

curl --request GET "https://emailapi.dynect.net/rest/json/senders/details?email=example@example.com&apikey=ABC123XYZ"

 

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"ready":1}}}

GET /senders/status

Retrieves the status of an approved sender. This is most useful when you create a new approved sender and need to know for sure whether it is ready to use.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • emailaddressRequired. Approved Sender’s Email Address

 

Example Request

curl --request GET "https://emailapi.dynect.net/rest/json/senders/status?email=example@example.com&apikey=ABC123XYZ"

 

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"ready":1}}}

POST /senders

Create or update an Approved Sender account.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • emailaddressRequired. Approved Sender’s Email Address.
  • seeding — Indicates whether this Approved Email Sender is also approved for seeding. Seeding is used to provide insight into inbox placement. See the Email Seeding page for more information.Valid values:
    1 = Approved sender is opted into seeding.
    0 = Default. Approved sender is not approved for seeding.

Example Request

curl --request POST "https://emailapi.dynect.net/rest/json/senders" --data "apikey=ABC123XYZ&emailaddress=example@example.com"

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":[]}}

POST /senders/dkim

Defines an Approved Sender’s DKIM Selector.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • emailaddressRequired. Approved Sender’s Email Address.
  • dkim – Defines an Approved Sender’s DKIM Selector.

Example Request

curl --request POST "https://emailapi.dynect.net/rest/json/senders/dkim" --data "apikey=ABC123XYZ&emailaddress=example@example.com&dkim=my-identifier"

Example Results (JSON)

{
"response":{
"status": 200,
"message": "OK",
"data":
{ "my-identifier._domainkey.mydomain.com": "k=rsa\\; t=y\\; p=MHwwDQYJKoZIhvcNA8593QADawAwaAJhAP3X49p188SrwGKsiPWU68lIzUJn8hsfEHLHuRU48aliKBuvg3wl3A9dix56h8mdBJOo+4DgRGhg2Egmxy4pevYyNT1t9Lrg8d9kl2byWhwMo+hBgiGKRUbMUhVpVyDlLQIDAQAB", "_domainkey.mydomain.com": "t=y\\; o=~\\;" }
}
}
}

POST /senders/delete

Deletes an approved sender from the account.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • emailaddressRequired. Approved Sender’s Email Address.

Example Request

curl --request POST "https://emailapi.dynect.net/rest/json/senders/delete" --data "apikey=ABC123XYZ&emailaddress=example@example.com"

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":[]}}