Contents
Authentication
Functions pertaining to authenticating with the API server.
Endpoint | Description |
authentication
|
In order to use any API commands, at any level, your client must first authenticate and obtain an authentication code.
This authentication code can then be used to make one or more calls to API functions.
See also Authentication.
|
revokeAuthentication
|
Revoke your authentication session and invalidate all authorization codes received.
See also Revocation.
|
Users
Functions pertaining to user logins.
User Settings
Endpoint | Description |
getUser
|
Return contact information and other general metadata for the user.
|
getUserSingleSignOnLoginURL
|
Create a URL that the user can click on which will automatically log the user into the Web Interface without needing to enter his/her username and password.
|
updateUser
|
Update contact information for the user.
|
getUserBrandingInformation
|
Return information that can be used to brand (private label) a user interface consistently with the branding the user would experience when logging in to WebMail.
|
getUserSettings
|
Return information regarding selected user preferences and settings.
|
getTimeZonesList
|
Return a list of all available time zones.
|
User Authentication
Email
AutoResponders
Forwarding
Endpoint | Description |
updateEmailForwarding
|
This function allows you to alter the email forwarding (and denial/deletion) settings for the user.
|
Email Sending
Endpoint | Description |
getDomainSmtpTlsCapability
|
This function checks if a specific domain name is valid, has good MX records, an supports a sufficiently good level of SMTP TLS
that LuxSci SecureLine can use TLS for secure email delivery.
|
retrieveSecureLineRecipientListEncryptionData
|
When composing an email message, you may have a list of recipients and want to know what kind of encryption, if any, would be used for each recipient when it is finally sent out with SecureLine encryption. This function allows you to check this without actually sending a message to these recipients.
|
sendEmail
|
Send email though your SMTP server(s). This is best for Secure High Volume email sending and SecureText through the API.
|
sendSecureEmailOrSecureText
|
This endpoint is deprecated.
See: sendEmail vs sendSecureEmailOrSecureText for sending email via the API.
|
Templates
Suppressions
Email suppressions that apply to all sending by a specific users. These also apply to messages sent by Secure Marketing if those messages are sent through the user in question's SMTP account.
WebAides
Note that in order to issue API commands that access a particular kind of WebAide (e.g. Calendars), your API Interface must he enabled to access that type of WebAide in the API Interface access control area. E.g., your API Interface could be configured so it can only access Calendars and not Tasks or any of the others. Similarly, it could have only Read access to specific types of WebAides.
See also the supporting documentation: WebAides Definitions
WebAide Containers
Endpoint | Description |
newWebAide
|
Create a new WebAide. E.g., creation of a new “Address Book”.
|
deleteWebAide
|
Delete a WebAide by unique ID. This WebAide must be owned by the user in question.
|
getWebAides
|
Return a list of all WebAides accessible to the specified user, that are also of the indicated type. You can use the query string to add filters to narrow down the results.
|
getWebAide
|
This call is like GetWebAides, except that the call is simplified and targeted at a specific, single WebAide.
|
WebAide Entries
WebAide Synchronization
Endpoint | Description |
addUpdateWebAideEntries
|
Add/update multiple entries of a WebAide all at once.
|
deleteWebAideEntries
|
Delete multiple entries from a WebAide all at once.
|
getWebAideEntries
|
Retrieve the detailed contents of all WebAide entries matching a query.
|
getCalendarEntriesDateRange
|
Gets a list of entries in a specified Calendar WebAide that fall within a specified range of dates. For recurring entries, the entry will be returned if any of its instances fall within the specified date range.
|
getWebAideChanges
|
Get WebAide changes. I.e., all entries that have changed or been added since a particular time. This is ideal for synchronization operations.
|
User Reports
See also the supporting documentation: API Reporting Basics
Email Sending Reports
Endpoint | Description |
getEmailSMTPSentReportUser
|
Return a list of all email messages sent via SMTP by a user.
|
getEmailWebMailSentReportUser
|
Return a list of all email messages sent via WebMail by a user.
|
getEmailSMTPDeliveryStatusReportUser
|
This report allows you to see how each SMTP message from email programs and devices was sent to each recipient and what the delivery status is for each of these recipients.
|
getEmailWebMailDeliveryStatusReportUser
|
This report allows you to see how each WebMail message was sent to each recipient and what the delivery status is for each of these recipients.
|
getEmailSMTPClickReportUser
|
This report allows you to query on the “URL click” events (or lack thereof) for email messages sent via SMTP that have email click tracking enabled.
|
getEmailWebMailClickReportUser
|
This report allows you to query on the “URL click” events (or lack thereof) for email messages sent via WebMail that have email click tracking enabled.
|
getEmailSMTPOpenReportUser
|
This report allows you to query on the “opened” events (or lack thereof) for email messages sent via SMTP that have email open tracking enabled.
|
getEmailWebMailOpenReportUser
|
This report allows you to query on the “opened” events (or lack thereof) for email messages sent via WebMail that have email open tracking enabled.
|
getEmailFeedBackLoopsReportUser
|
This report allows to see what messages that you have sent successfully have been “marked as spam” by recipients and this information has come back to us via one of our feed-back loops.
|
User Login / Failure Reports
Endpoint | Description |
getEmailSMTPLoginFailureReportUser
|
This report allows to see all SMTP login failures, as well as sending errors that resulted from our servers explicitly rejecting your request to send an email message for one reason or another.
|
User Management
Administrative functions for managing users and user logins. Note that administrators can also employ user-scope user API endpoints to further manage and modify users (e.g., to change a user's password).
Endpoint | Description |
getUserReport
|
Return an array of information about all users matching your query request.
|
createUser
|
Create a new user in your account.
|
deleteUser
|
Delete a user from your account.
|
renameUser
|
Change user's login email address.
|
updateUserSettings
|
Change one or more properties of the user.
|
Domain Management
Administrative functions for managing domains.
Endpoint | Description |
createDomain
|
Create a new domain in your account.
|
getDomainsReport
|
Get information about your domains.
|
deleteDomain
|
Remove a domain from your account.
|
updateDomain
|
Change selected domain settings.
|
getDomainDetails
|
Get information about a specific domain. This is the same as the “Get Domain Report,” except that it returns data for 1 specific domain.
|
Account-level Email Management
Administrative functions for managing account-level email settings.
Email Aliases
Endpoint | Description |
createAlias
|
Create new alias(es) in your account.
|
getAliasesReport
|
Get information about your email aliases including regular aliases user forwards, domain catchalls, and WebAide Group distribution lists.
|
getAliasDetails
|
Get information about a specific email alias.
|
updateAlias
|
Modify an existing alias in your account.
|
deleteAlias
|
Remove an alias with the specified alias email address from your account.
|
Domain Keys Identified Mail - DKIM
Endpoint | Description |
createDkim
|
Create a new DKIM configuration in your account.
|
getDkimReport
|
Get information about your DKIM configurations.
|
getDkimDetails
|
Get information about a specific DKIM configuration. This is the same as the “Get DKIM Report,” except that it returns data for 1 specific domain.
|
deleteDkim
|
Remove a DKIM configuration from your account.
|
Account-level Suppressions
Email suppressions that apply to all sending by all users in the account. These also apply to messages sent by Secure Marketing.
SecureSend Namespaces
Customers with Private Labeling and SecureLine may choose to setup NameSpace(s) to associate with their Private Labeled themes. These NameSpaces segregate the SecureSend users of these themes from the SecureSend users of other themes and of other LuxSci customers. These functions allow you to manage the users in a particular SecureSend NameSpace in your account.
You need your “namespace id” number to use these functions. This can be found in the “SecureSend User NameSpaces” page accessible in your Private Labeling configuration area. These API functions only permit you to manage users in NameSpaces in your account.
Secure Marketing
The LuxSci Secure Marketing API is a subset of the LuxSci Account API
with commands specifically for the LuxSci Secure Marketing system. Secure
Marketing API commands are “account” scope.
The API functions described herein allow your API client to
programmatically access, insert, add, update and delete resources
effectively within LuxSci Secure Marketing platform. This means you can
perform functions programmatically on specific contacts, contact lists,
and statistics automatically from third-party applications or custom code.
Linking the API to your Secure Marketing Login(s)
In order to use the LuxSci Secure Marketing API commands, you need to link
your API configuration to a specific user in the Secure Marketing
interface. The API commands will then operate through that user on that
user’s data and with that user’s level of access to the system.
To do this, you need to make a support ticket in the LuxSci web
interface requesting that this operation be performed for you.
Marketing List Management
Endpoint | Description |
addMarketingContact
|
Add New Contact.
|
getMarketingContacts
|
This call permits you to get your contacts’ data from the system by specific list or in aggregate. None of the request body parameters are required, and if you leave them blank, the call will return all contacts’ data from all your lists.
|
getMarketingContactById
|
This function allows you to get the details for specific contact using his/her contact ID.
|
updateMarketingContactById
|
Update the details, including custom field values, of a contact, using their contact ID.
|
updateMarketingContactByEmail
|
Update the details, including custom field values, of contacts with the specified email address.
|
deleteMarketingContactById
|
Delete Contact By ID.
|
markContactAsUnsubscribed
|
Changes a contact’s status to “unsubscribed.” This is more efficient than calling updateContact to make this change.
|
Marketing Campaign Management
Marketing Suppressions
These suppression endpoints apply only to messages sent from Secure Marketing. User-level and Account-level suppressions also apply.
Marketing Reports / Statistics
Administrative functions for managing Secure Form configurations and data.
Endpoint | Description |
getSecureFormList
|
Return a list of all Secure Form configurations currently defined in your account.
|
getSecureForm
|
Returns details on a specific Secure Form configuration, based on the configuration’s unique ID.
|
getSecureFormDatabasePosts
|
Returns details on the posts currently stored in the database table associated with a specific Secure Form configuration. This function is recommended for use when synchronizing or periodically downloading new rows to an external source: it allows you to quickly and easily see what, if any, entries are new relative to your last actions (if you saved the last index or date when you previously downloaded data).
|
getSecureFormDatabaseRows
|
This function returns the actual content of all database rows matching your query.
|
getSecureFormDatabaseRow
|
This function works the same as “Get Secure Form Database Rows”, except that you specify the row index and get back up to 1 row.
|
deleteSecureFormDatabaseRow
|
This function allows you to delete a row from your Secure Form database, based on the row index.
|
getSecureFormDatabaseFile
|
This function is used to retrieve a file associated with a row in your Secure Form database.
|
deleteSecureFormDatabaseFile
|
This function is used to remove a file associated with a row in your Secure Form database.
|
Servers
Administrative functions for managing dedicated servers.
Endpoint | Description |
getServers
|
This report allows you to retrieve general information about all of the dedicated servers associated with your account.
|
getServerStatus
|
This report allows you to retrieve specific current status of a specific server.
|
Account Reports
There are many reports available in the LuxSci user interface. Some
of these are account-wide and some are the same reports, but restricted to
a particular user's activity.
Access to all of these reports is very similar. They all use an HTTP
GET; account-wide reports use account scope; similar user-specific reports
are available under user scope. All reports use the same mechanism for
restricting date ranges and requesting particular "pages" of results. The
following section specifies the usage features common to all of these
report types. The subsequent sections discuss each of the particular
account scope reports available. See the User Reports
section for a list of the respective user-scope reports.
See also the supporting documentation: API Reporting Basics
Email Sending Reports
Email sending reports that show results for all users in your account.
Endpoint | Description |
getEmailSMTPSentReportAccount
|
Return a list of all email messages sent sent via SMTP by users in this account.
|
getEmailWebMailSentReportAccount
|
Return a list of all WebMail email messages sent by users in this account.
|
getEmailSMTPDeliveryStatusReportAccount
|
This report allows you to see how each SMTP message was sent to each recipient and what the delivery status is for each of these recipients.
|
getEmailWebMailDeliveryStatusReportAccount
|
This report allows you to see how each WebMail message was sent to each recipient and what the delivery status is for each of these recipients.
|
getEmailSMTPClickReportAccount
|
This report allows you to query on the “URL click” events (or lack thereof) for email messages sent via SMTP that have email click tracking enabled.
|
getEmailWebMailClickReportAccount
|
This report allows you to query on the “URL click” events (or lack thereof) for WebMail email messages that have email click tracking enabled.
|
getEmailSMTPOpenReportAccount
|
This report allows you to query on the “opened” events (or lack thereof) for email messages sent via SMTP that have email open tracking enabled.
|
getEmailWebMailOpenReportAccount
|
This report allows you to query on the “opened” events (or lack thereof) for email messages sent via WebMail that have email open tracking enabled.
|
getEmailFeedBackLoopsReportAccount
|
This report allows to see what messages that you have sent successfully have been “marked as spam” by recipients and this information has come back to us via one of our feedback loops.
|
Login / Failure Reports
Endpoint | Description |
getSMTPLoginFailureReportAccount
|
This report allows to see all SMTP login failures, as well as sending errors that resulted from our servers explicitly rejecting your request to send an email message for one reason or another.
|