API docs

Appearance

On this page

Changelog ​

2025 ​

AUG ​

v1.2 ​

CHANGE Breaking changes

  • Support was added for emails to be associated with multiple campaigns
  • Requests using Version 1.2 or later will include the campaigns property as an array of campaigns when retrieving an email
  • Requests using Version 1.1 and earlier will continue to include a campaign property with a single campaign when retrieving an email

CHANGE Update contact attributes

  • No longer required to supply the entire attributes object when updating a contact.
  • Keys in the attributes object in the request payload will overwrite existing attributes for the contact. Other attributes not specified in the request will remain unchanged.
  • To remove a key from a contact's attributes, you must supply a null value for that key.

FEATURE Lookup contacts by external_id

  • Added external parameter to retrieve, update, and delete endpoints.
  • Allows lookup of contacts by their external_id instead of the id that is assigned by Workshop.

JUN ​

FEATURE Web visits endpoint

MAY ​

v1.1 ​

CHANGE Breaking changes

  • Paginated endpoints previously used object: "list" in their response to indicate that the response data was a list of records. This has been changed to object: "array" to avoid confusion with Workshop Lists.
  • Requests using Version 1.1 or later will see object: "list" used for responses containing a Workshop List record.
  • Requests using Version 1.0 will see object: "list" used both for paginated responses and for responses containing a Workshop List record.

CHANGE Pagination

  • The limit parameter now defaults to 50 instead of 5. Page size can still be set between 1 and 100, as before.

LAUNCH Lists endpoints

FEB ​

v1.0 ​

LAUNCH Contacts endpoints

  • Added endpoints for retrieving Contacts.
  • Added endpoints for creating, updating, and deleting contacts for those using the API as their sync source.

LAUNCH API versioning

  • The API key can now be pinned to a specific version.
  • The Workshop-Version header can be used to override the API key's pinned version.
  • See the Versioning documentation for more information.

CHANGE Pagination strategy

  • The Pagination strategy was updated to use cursor-based pagination instead of offset-based pagination. This change was made to ensure consistency of results when paging through large datasets.
  • See the Pagination documentation for more information.

2024 ​

Prior to 2025, the API was not versioned. It only included GET endpoints for retrieving detailed analytics data from Workshop.

FEATURE Emails endpoints

FEATURE Campaigns endpoints

FEATURE Links endpoints