Functions pertaining to authenticating with the API server.
Endpoint | Description |
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. | |
Revoke your authentication session and invalidate all authorization codes received. See also Revocation. |
Functions pertaining to user logins.
Endpoint | Description |
Return contact information and other general metadata for the user. | |
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. | |
Update contact information for the user. | |
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. | |
Return information regarding selected user preferences and settings. | |
Return a list of all available time zones. |
Endpoint | Description |
This command changes the user's password. | |
This command creates a new user app-specific password/login for a specific user. | |
This command removes a user app-specific password/login for a specific user. | |
This command creates a list of all app-specific password/logins defined for a specific user. | |
This command creates a list of all app-specific password/logins defined for a specific user. |
Endpoint | Description |
Create a new email auto-responer. | |
Return all email auto-responders owned by this user. | |
Delete an email auto-responder that belongs to the user. |
Endpoint | Description |
This function allows you to alter the email forwarding (and denial/deletion) settings for the user. |
Endpoint | Description |
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. | |
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. | |
Send email though your SMTP server(s). This is best for Secure High Volume email sending and SecureText through the API. | |
This endpoint is deprecated. See: sendEmail vs sendSecureEmailOrSecureText for sending email via the API. |
Endpoint | Description |
The call returns the specific details around a specific Email Template. | |
Revise the contents of an existing Email Template. | |
Delete a specific Email Template. | |
This function returns a list of all templates accessible to you. | |
Define a new email template. | |
Change the name of a Template Group. | |
Delete a specific Template Group. | |
This function returns a list of all templates accessible to you. | |
Define a new email template group. |
Endpoint | Description |
Create/define a new Custom Field for use with Secure Marketing v3 or Advanced Secure High Volume. | |
Return a list with properties of all Custom Fields available. |
Endpoint | Description |
The call returns the specific details around a specific Content Tag | |
Revise the contents of an existing Content Tags. | |
Delete a specific Content Tag. | |
This function returns a list of all Content Tags accessible to you. | |
Define a new Content Tag. |
Endpoint | Description |
Create a new subdirectory in the Content Library. | |
Delete an empty subdirectory from the Content Library. | |
Delete a file from the Content Library. | |
Retrieve details about a specific subdirectory including a list of all files and subdirectories within it. | |
Retrieve details about a specific file. | |
Add a new file to the Content Library. |
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.
Endpoint | Description |
Delete a specific user-level email suppression. | |
Retrieve a specific user-level email suppression. | |
Retrieve all email suppressions at the user level. | |
Add new email suppressions at the user level. |
The LuxSci Secure Marketing v3 API is a subset of the LuxSci Account API with commands specifically for the LuxSci Secure Marketing v3 system. Secure Marketing v3 API commands are “user” scope and provide visibility into marketing assets owned by or shared with the user used in the API request. Note, if you are using Secure Marketing v2, then these endpoints do not apply to you.
Endpoint | Description |
Add a New Contact List | |
Delete a Contact List and all Contacts in it | |
Rerieve details of a particular List. | |
Rerieve the details of some/all Lists in a report-style response. | |
Update the details of a List and/or assign custom fields. | |
Add a New Contact List Group | |
Delete a Contact List Group | |
Rerieve the details of all List Groups | |
Update the name of a List Group. |
Endpoint | Description |
Add New Contact to a List | |
Add New Contacts in Bulk | |
Delete a contact from a List | |
Retrieve the details and custom field data for a specific contact. | |
Retrieve the details and custom field data for contacts in bulk (using a report-style response). | |
Update the properties of a Contact. |
Endpoint | Description |
Add New Campaign | |
Delete a Campaign | |
Return details about the specified Campaign. | |
Return a report listing details about all Campaigns meeting specified criteria (e.g., recently updated or created). | |
Update the properties of a Campaign. |
Endpoint | Description |
Return a report of raw log data for each individual sending event for a list of Campaigns. This includes information about every recipient as well as the delivery status disposition of every message and other details (e.g., if the message was opened or clicked on, etc.). | |
Return a report of bounce data (i.e., the email delivery failure data) for a list of Campaigns. | |
Return a report of data for each email open event for a list of Campaigns. | |
Return a report of data for each click event for a list of Campaigns. | |
Return a report of urls clicked on, aggregted across all click events for a list of Campaigns. | |
Return Unsubscribe data for a list of Campaigns. | |
Return spam complaint data for a list of Campaigns. |
A number of other API calls found elsewhere in this guide are directly related to Marketing v3:
See also the supporting documentation: API Reporting Basics
Endpoint | Description |
Return a list of all email messages sent via SMTP or API by a user. | |
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. | |
This report provides summary statistics on the email delivery status, open status, click status, encryption status, and suppression status of messages sent or updated in a time interval. | |
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. | |
This summary report provides a count of the number of URL click events made during a time interval. | |
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. | |
This summary report provides a count of the number message open events during a time interval. | |
Return a list of all email messages sent via WebMail by a user. | |
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. | |
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. | |
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. | |
This report allows you 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. | |
This summary report gives the number of Spam complaints made by recipients during a time interval. | |
Retrieve email suppressions. | |
Retrieve the total number of email suppressions created duing a specific time range. | |
This report provides access to temporary email delivery failure messages that were received (if any) while trying to deliver specific email messages. |
Endpoint | Description |
This report allows you 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. |
Endpoint | Description |
Return a list of all asynchronous reporting jobs submitted by this user in the past 7 days. | |
Return details for a specific asynchronous reporting job. |
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
Endpoint | Description |
Create a new WebAide. E.g., creation of a new “Address Book”. | |
Delete a WebAide by unique ID. This WebAide must be owned by the user in question. | |
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. | |
This call is like GetWebAides, except that the call is simplified and targeted at a specific, single WebAide. |
Endpoint | Description |
Create a new WebAide Entry. | |
Delete an existing WebAide Entry. | |
Retrieve the detailed contents of a specific WebAide entry. | |
Update an existing WebAide Entry. |
Endpoint | Description |
Add/update multiple entries of a WebAide all at once. | |
Delete multiple entries from a WebAide all at once. | |
Retrieve the detailed contents of all WebAide entries matching a query. | |
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. | |
Get WebAide changes. I.e., all entries that have changed or been added since a particular time. This is ideal for synchronization operations. |
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 |
Return an array of information about all users matching your query request. | |
Retrieve information about the list of users in your account using a report-style API interface call. | |
Retrieve the number of users in your account created during a specific date range using this summary report call. | |
Create a new user in your account. | |
Delete a user from your account. | |
Change user's login email address. | |
Change one or more properties of the user. |
Administrative functions for managing domains.
Endpoint | Description |
Create a new domain in your account. | |
Get information about your domains. | |
Remove a domain from your account. | |
Change selected domain settings. | |
Get information about a specific domain. This is the same as the “Get Domain Report,” except that it returns data for 1 specific domain. |
Administrative functions for managing account-level email settings.
Endpoint | Description |
Create new alias(es) in your account. | |
Get information about your email aliases including regular aliases user forwards, domain catchalls, and WebAide Group distribution lists. | |
Get information about a specific email alias. | |
Modify an existing alias in your account. | |
Remove an alias with the specified alias email address from your account. |
Endpoint | Description |
Create a new DKIM configuration in your account. | |
Get information about your DKIM configurations. | |
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. | |
Remove a DKIM configuration from your account. |
Endpoint | Description |
Add a Custom Bounce Domains to your account. This API call assumes that DKIM for the domain has already been added and required DNS changes have already been made. |
Email suppressions that apply to all sending by all users in the account. These also apply to messages sent by Secure Marketing.
Endpoint | Description |
Delete a specific account-level email suppression. | |
Retrieve a specific email suppression at the account level. | |
Retrieve all email suppressions at the account level. | |
Add new email suppressions at the account level. |
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.
Endpoint | Description |
Create a new SecureSend User in a specific NameSpace. | |
You can do this with the User Update function, above. We provide a simple, direct method here as well. | |
Create a URL that the user can click on which will automatically log the user into the SecureSend Interface without needing to enter his/her username and password. | |
Return a list of all users in this NameSpace. |
The LuxSci Secure Marketing v2 API is a subset of the LuxSci Account API with commands specifically for the LuxSci Secure Marketing v2 system. Secure Marketing v2 API commands are “account” scope. Note, if you are using Secure Marketing v3, then these endpoints do not apply to you.
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.
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.
Endpoint | Description |
Add a New Contact List | |
Delete a Contact List | |
Delete a Group of Contact Lists | |
Return details about one or more specific Contact List(s). | |
Update information for existing Contact Lists such as From Name or From Address or assign custom fields. | |
Return details of contact list groups |
Endpoint | Description |
Add New Contact. | |
Add multiple New Contacts. | |
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. | |
This function allows you to get the details for specific contact using his/her contact ID. | |
Update the details, including custom field values, of a contact, using their contact ID. | |
Update the details, including custom field values, of contacts with the specified email address. | |
Delete Contact By ID. | |
Changes a contact’s status to “unsubscribed.” This is more efficient than calling updateContact to make this change. |
Endpoint | Description |
This call allows you to retrieve details on your campaigns. | |
Create a new email broadcast campaign. | |
Update a Campaign | |
Delete a Campaign. | |
Schedule Campaign | |
Return details of campaign groups | |
Return details of scheduled campaigns |
These suppression endpoints apply only to messages sent from Secure Marketing. User-level and Account-level suppressions also apply.
Endpoint | Description |
Add New Suppression | |
Get Suppressions | |
Delete Suppression |
Endpoint | Description |
Get Campaign statistics summary | |
Get Campaign bounced statistics | |
Get Campaign Opened statistics | |
Get Campaign Clicked statistics | |
Get Campaign Unsubscribed statistics |
Administrative functions for managing Secure Form configurations and data.
Endpoint | Description |
Return a list of all Secure Form configurations currently defined in your account. | |
Returns details on a specific Secure Form configuration, based on the configuration’s unique ID. | |
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). | |
This function returns the actual content of all database rows matching your query. | |
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. | |
This function allows you to delete a row from your Secure Form database, based on the row index. | |
This function is used to retrieve a file associated with a row in your Secure Form database. | |
This function is used to remove a file associated with a row in your Secure Form database. |
Administrative functions for managing dedicated servers.
Endpoint | Description |
This report allows you to retrieve general information about all of the dedicated servers associated with your account. | |
This report allows you to retrieve specific current status of a specific server. | |
Remove messages from all email queues. | |
Remove all unprocessed messages from all email queues. | |
Update email processing rate limits. |
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 that show results for all users in your account.
Endpoint | Description |
Return a list of all email messages sent sent via SMTP by users in this account. | |
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. | |
This report provides summary statistics on the email delivery status, open status, click status, encryption status, and suppression status of messages sent or updated in a time interval. | |
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. | |
This summary report provides a count of the number of URL click events made during a time interval. | |
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. | |
This summary report provides a count of the number message open events during a time interval. | |
Return a list of all WebMail email messages sent by users in this account. | |
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. | |
This report allows you to query on the “URL click” events (or lack thereof) for WebMail email messages that have email click tracking enabled. | |
This report allows you to query on the "opened" vents (or lack thereof) for email messages sent via WebMail that have email open tracking enabled. | |
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. | |
This summary report gives the number of Spam complaints made by recipients during a time interval. | |
Retrieve email suppressions at the account level. | |
Retrieve the total number of email suppressions created during a time interval. | |
This report provides access to temporary email delivery failure messages that were received (if any) while trying to deliver specific email messages. |
Endpoint | Description |
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. |
Endpoint | Description |
Return a list of all asynchronous reporting jobs submitted by this account in the past 7 days. | |
Return details for a specific asynchronous reporting job. |