Skip to main content
    API referenceModulesAccount setupCommunication settingsEmail

Email

Method - EmailSMTP#

Consider the method to set the email settings to perform the platform-specific activities for all the emails sent to the recipients over the platform. The SMTP configurations set in Communication settings for an account includes the server’s name, username, port, and status.

URL: https://domain/api/ClientManagement/GetClientSMTPInformation

Request data:

Response data:

Method - EditSMTP#

Consider the method to revise/edit the email settings to perform the platform-specific activities for every email sent to the recipients over the platform.

URL: https://domain/api/ClientManagement/GetClientSMTPInformation

Request data:

Response data:

Method - SaveSMTP#

The method saves the email settings set in the Communication settings.

URL: https://domain/api/ClientManagement/SaveClientSMTPInformation

Request data:

Response data:

Method - Subscribe#

Consider the method to set the communication settings to subscribe receipt of an email campaign from the platform.

The subscribe option is a feature at the email footer usually available as a hyperlink.

URL: https://domain/api/Recipients/ManageSubscribeSetting

Request data:

Response data:

Method - Subscribe - Edit#

The method enables revision/editing of the subscription settings set in the Communication settings for an email campaign.

URL: https://domain/api/Recipients/ManageSubscribeSetting

Request data:

Response data:

Method - Subscribe - Save#

The method enables to retain/save the subscription settings set in the Communication settings for an email campaign.

URL: https://domain/api/Recipients/ManageSubscribeSetting

Request data:

Response data:

Method - Subscribe – Update#

Consider the method to update the subscription settings set in the Communication settings of an email campaign.

URL: https://domain/api/Recipients/ManageSubscribeSetting

Request data:

Response data:

Method - Unsubscribe#

Consider the method to set the communication settings to unsubscribe receipt of an email campaign from the platform.

The unsubscribe option is a feature at the email footer usually available as a hyperlink. By default, the un-subscription library display includes all the un-subscription settings configured for the email channel of an account.

URL: https://domain/api/Recipients/ManageUnSubscribeSetting

Request data:

Response data:

Method - Unsubscribe - Update#

Consider the method to update the unsubscription settings set in the Communication settings for an email campaign.

URL: https://domain/api/Recipients/ManageUnSubscribeSetting

Request data:

Response data:

Method - Emailfooter#

Consider the method to add the footer section of an email campaign. The email footer is the last block of all email newsletters, and it contains contact information, such as the brand name, website address, postal address, and unsubscribe links.

URL: https://domain/api/ClientManagement/GetEmailFooters

Request data:

Response data:

Is this page helpful?