Code preference:
Curl
Ruby
Php
Python
Node.js
C#
Java

Your sender

Developers can access their senders information as well as manage it using this API. Following are the various operations supported by this API.

This API call will let you access your created senders information.

Input Parameter Description
option Options to get senders. Possible options – IP-wise, & Domain-wise ( only for dedicated IP clients ). Example: to get senders with specific IP, use $option=’1.2.3.4′, to get senders with specific domain use, $option=’domain.com’, & to get all senders, use $option=” [Optional].

Example :

Sample Output ( for dedicated IP ) :

Sample Output ( for shared IP ) :

Output Parameter Description
id It is the unique ID of the sender
from_name This is the sender name from which the campaign emails are sent
from_email This is the sender email from which the campaign emails are sent
ip This is the dedicated IP
sign_domain This is the domain name provided by the client during sender creation/updation and it will be used to sign the email (DKIM)
smtp_domain This is the domain name associated with dedicated IP
enabled This determines that dedicated IP and its associated domain name is in use or not

This API call will let you create your senders.

Input Parameter Description
sender_name Name of the sender [Mandatory].
sender_email Email address of the sender [Mandatory].
ip_domain Pass pipe ( | ) separated Dedicated IP and its associated Domain. Example: “1.2.3.4|mydomain.com”. You can use commas to separate multiple ip_domain’s [Mandatory: Only for Dedicated IP clients].

Example :

Sample Output :

If successful, It returns the ID of the created sender.

This API call will let you delete your sender information.

Input Parameter Description
id Id of sender to be deleted [Mandatory].

Example :

Sample Output :

This API call will let you update your senders. You can only update new senders.

Input Parameter Description
id Id of sender to be modified [Mandatory].
sender_name Name of the sender [Mandatory].
ip_domain Pass pipe ( | ) separated Dedicated IP and its associated Domain. Example: “1.2.3.4|mydomain.com”. You can use commas to separate multiple ip_domain’s [Mandatory: Only for Dedicated IP clients].

Example :

Sample Output :