APIs

  • Async Results

    The Async Results API is used to get the status of an invidual asynchronous request at the record level.

  • Company

    The Company API provides information on company specific settings and status. Developers can use this service to get message encoding options, reply to and from addresses, subscription lists (division) and settings. The v2/company/ping resource can be used to determine if the API services are available and healthy.

  • Content-Blocks

    The Content Blocks API manages an assembled instance of what is referred to as 'content blocks' or content IDs in Yesmail360 interface.These include blocks of attachments, text, html and javascript code used in one or more masters. In many ways a content block is a lightweight version of a masters/template.

  • Emails

    The Emails API is a transactional messaging service. It is designed for sending 1 to 1 messages to individuals that are either subscribed or not subscribed to a mailing division. The Emails API supports pure transactional messaging, this is useful if you are required to send messages to inviduals that have opted out of your messaging programs. Use the transactional=true flag to bypass subscription logic. Subscribe and Send requests can also be made using the Emails API. When adding new subscribers and sending them a welcome message, define their profile information, add their new subscription and designate them as members of the division. If you do not know whether the requestor is a subscriber or you do not wish to resubscribe them, you must first do a look-up of their subscription using GET /v2/subscribers//subscriptions.

  • Masters

    The Masters API is the primary service for interacting with marketing messages that will be sent to a large targeted audience of subscribers. This service supports the creation, updating, reading, archiving, enabling, and disabling of messages.
    This service is primarily used by clients that are managing message creation and creative design outside the Yesmail Marketing Platform user interface.
    A master is composed of four main components, targeting, scheduling, template (content and envelope), and delivery parameters. The first three have been broken out from the master as separate resources, so they can be independenly updated. Most delivery parameters have default values defined at the company level and are rarely updated.

  • Pushes

    Transactional message service for sending push notifications

  • Reference-Data

    With the Reference-Data API, a client can interact with and query existing custom data tables, and have the abilty to:

    • Retrieve lists of custom data tables
    • Retrieve all entries from a custom data table
    • Retrieve entries from a custom data table based on specified criteria. Note: primary key must be defined for custom data table
    • Append entries to a custom data table

  • Reports

    Message key performance indicators and individual subscriber interactions can be reported through the Reports API. This is a complementary report to the /v2/subscribers//emails/ report. Bulk message open and click events peak about 12 hours after delivery and decreases in activity significantly after 4 to 6 days. Wait several days after delivery to request a report to capture the most event information. Reports are retained for 7 days, then they must be requested again.

  • Subscribers

    With the Yesmail Subscribers API, a client can interact with Yesmail’s core systems in order to perform subscriber management activities.

    A subscriber is considered to be anyone who belongs to or opts-in to a service or e-commerce firm and knowingly receives email messages from the service or company. It can also be someone who has unsubscribed from all messages.

    A subscriber is specified via a company-defined identifier (ID). This identifier can be any string that is uniquely associated with a subscriber within a particular business unit in your organization. The ID will be tied in Yesmail’s systems to the subscriber’s profile information (including attributes), subscriptions, and message history for that business unit.

    Note that if an ID is used across business units, it is stored separately for each business unit. The profile information, subscriptions, and message history for that ID are not joined across business units.

    A subscription (or division) represents the level of organization at which the subscriber may opt-in, or subscribe. For instance, your company may have five different product areas; a subscriber may be opted in to one or more of these areas, while not subscribed to the others. Depending on the API call, the response payload may contain a memberOf array listing the divisions to which the subscriber is subscribed, and/or a current array that lists all available divisions and the subscriber's current status for each one.

    A subscriber that is marked dead due to exceeding the hard bounce rules, is not editable. However, they can be revived through any of the subscriber update resources by setting dead=false.

    Please note that all subscriber call email addresses must be lower-case strings. Calls containing email addresses in mixed case will be rejected.

  • Target Lists

    The Target Lists API allows clients to manage lists of subscribers for use in targeting. With the Target List API clients can:

    Retrieve a list of target lists and number of subscribers Retrieve list and number of subscribers for a target list Add or remove individuals subscribers from a target list Batch add subscribers to a target list Archive a target list

    Target lists provide a convenient mechanism to sort specific groups of subscribers. These lists can contain subscribers from a particular marketing initiative, from a specific source or system. Target lists are available for use in the Yesmail Enterprise Marketing platform when defining the targeting for a message.