Using the Websand Subscriber API

Use the Websand subscriber API to connect your subscriber data from your platform into Websand. Once connected, you’ll have a data flow.

The data will update or add subscribers to your marketing audience. The updated contacts will be updated into any relevant segments. If that segment is part of an automation, they’ll then be included in any marketing automation campaigns you have in place.

That’s how data driven marketing works in Websand.

Websand Subscriber API Documentation

Using this document

This document provides details on using the Websand API. That is feeding data from your platform or business system directly into Websand in an automated fashion.

You will need to have a Websand account set up before you start the API process.

If you are using an existing established e-commerce platform we probably already have an API in place (or planned) so please get in touch.

If you are looking to connect your own bespoke data or platform.  Please proceed 🙂


The Websand API is an HTTPS interface with endpoints for specific actions.

The API follows REST conventions by using HTTPS verbs equivalent to the request type – requests to delete resources use the DELETE HTTPS verb, resource creation requests use the POST verb etc.

Authentication is handled via a HTTPS Token authentication header which can be generated from your Websand instance.

"Authorization: Token {YOUR-API-KEY}"

General Data Endpoints:

Websand has two API endpoints you can use.

The subscriber endpoint which accepts non transactional customer data – i.e. a list of people.

The transactional endpoint accepts customer transactional data (events and the people those events relate to).   Click here for more details on the Transactional API

Subscriber Endpoint

Note:  Rather than use this part of the API, if you have a WordPress website, then it might be easier for you to use our WordPress widget – that will take care of the subscriber signup process for you.  

The subscriber endpoint which accepts non transactional customer data – i.e. a list of people.  This is your traditional email list or sign up data.

POST  https://{{your_websand_name}}

Receives customer subscriber data in JSON format for processing and indexing and requires authentication.  This is not transactional data, typically people that have signed up without purchasing anything.

The API supports custom additional fields, which can be included in the request as required by the customer.  Minimal request body is below.  This is the MINIMAL REQUEST.

  • The date of signup
  • The email address
  • The source code (where they signed up)

You can include any additional information you require.

      "email": "", 	
      "source": "TwitBook", 	
      "subscribed_at": "2016-11-23T15:33:00Z"

Response Statuses

2xx responses

2xx responses indicate successful requests.  The beautiful #200’s, it’s all good.

4xx responses

4xx responses indicate issues with request data/authentication – response body should include specific error message(s) to help you go all Sherlock and figure out the issue.  Something wrong at your side – get in touch and let’s see how we can help.

5xx responses

5xx responses indicate server-side issues. OMG. Something wrong at our side – please raise the alarm and let us know.

Notes when using the API

submit_datetime is the timestamp used for any date-range processing in the WebsandHQ system and is ISO 8601 format.

Need some help?

Need help with the API?

If you need more help using the Websand API, or further help with your email marketing or data strategy. We can help. Get in touch by email, give us a call +44.113.2045925 or schedule some time by clicking the box below 

Lets talk
Websand getting started
Websand Import Data
Websand dynamic segmentation
Websand Email Design
Websand Sending Email Icon
Websand marketing automation