API Guide







Overview

All API requests utilize REST methods resulting in JSON, XML, CSV, or Serialized output. To request new API functionality please feel free to contact us.

Every API request requires the use of the X-API-KEY header, which is located in your account settings. For child API keys please visit the Child Accounts section of your settings.

API Workflow

  1. Package API request using the programming language of your choice
  2. Perform data GET/PUT/POST/DELETE requests to https://api.250ok.com/api/1.0/
  3. Return data in the format of your choice using the ACCEPT header


Release Notes

  • 10/18/2017
    Analytics: Added "Get Engagement Filters", "Create Export", "Get Exports", "Get Export"
  • 8/16/2017
    Added Get Deliverability Summary endpoint to the Inbox API
  • 6/1/2017
    Added Get ISP Health endpoint to the Inbox API
  • 10/7/2016
    Added Get, Post, Delete for DMARC domains plus reports for DMARC compliance (broken down by day and domain), change history, failure, report sources, mail sources.
  • 7/25/2016
    Get, Put, Post child accounts: added subscription and usage fields for Reputation, DMARC, Design, and Analytics.
  • 5/5/2016
    Inbox: added endpoints Optimizer Summary, Optimizer Results, Start Campaign Diagnostics, and Get Campaign Diagnostics.
  • 4/7/2016
    Inbox: Campaign Summary now include SPF & DKIM pass percentages.
  • 1/7/2016
    Added Design get optimizations API.
  • 11/27/2015
    Added SNDS IP status API.
    Modified SNDS APIs to work with inherited keys from parent accounts.
  • 11/1/2015
    Added ability to create and modify Blacklist profiles.
    Added numeric list of monitored blacklists to the Profile Summary API.
    Added ability to filter Blacklisted History by Profile ID.
  • 10/1/2015
    Added SNDS endpoints to Reputation
  • 9/13/2015
    Added 'tab' element to Inbox ISP Detail response. This shows which Gmail Inbox tab displayed the email.
  • 8/15/2015
    Added additional search parameters to Design - Get Test Count
  • 7/20/2015:
    Added ability to search Design tests by keyword.
  • 7/7/2015:
    Added completed times for Design tests and individual renderings.
  • 6/15/2015:
    Added external identifiers (external_id) support to Account Services in the Aliases/Child Accounts endpoints.
  • 6/1/2015:
    Added Account Services endpoints for Get Alias(es), Create Alias, Update Alias, and Delete Alias
  • 5/4/2015:
    Added Design - Get Mobile Device HTML endpoints
  • 2/23/2015:
    Added Reputation API endpoints
  • 12/3/2014:
    Added Design API endpoints
  • 12/2/2014:
    Added Analytics API endpoints
  • 11/10/2014:
    Added support for assigning unique IDs to blacklisted items in a profile to easily track history
  • 6/4/2014:
    Added support to query campaigns by X-Header
    Added support for GET/PUT/POST/DELETE child account to easily add, edit, or delete child accounts.
    Added support for POST child API key to easily generate new API keys.
    Merged legacy Attribute Search API into the Campaign Summary call as additional parameters.