Campaigns

Campaigns allow users to send direct mail based on a real time events or actions which is specific to an individual customer. Each campaign has it's own configuration of required data in order to trigger a relevant ZAP for example a an abandoned basket campaign might require a session ID and a list of products but a customer birthday might only expect the recipient info and a birthday date

Users can list all campaigns available in ZAP POST. This will provide some basic campaign information such as the name and current status.

GET/api/v1/campaigns

Response

200400401

Success

Body

application/json

idstring (uuid)

clientIdstring (uuid)

namenullable string

descriptionnullable string

startDatestring (date-time)

durationinteger (int32)

zapLimitinteger (int32)

csvPathnullable string

enabledboolean

statusnullable string

templateTypeIdstring (uuid)

paperStockTypeIdstring (uuid)

zapsSentinteger (int32)

archivedDatestring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/campaigns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "startDate": "2024-11-21T06:58:45.053Z",
    "csvPath": "text",
    "enabled": false,
    "status": "text",
    "templateTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "paperStockTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "archivedDate": "2024-11-21T06:58:45.053Z"
  }
]

Users can also look up a specific campaign which will include more detailed information regarding the custom field configuration on the campaign such as expected values and validation expressions.

GET/api/v1/campaign/{campaignId}

Path parameters

campaignId*string (uuid)

Response

200401

Success

Body

application/json

idstring (uuid)

namenullable string

descriptionnullable string

startDatenullable string (date-time)

statusnullable string

fieldsnullable array of CampaignDetailsField (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/campaign/{campaignId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "startDate": "2024-11-21T06:58:45.053Z",
  "status": "text",
  "fields": [
    {
      "name": "text",
      "description": "text",
      "label": "text",
      "exampleValue": "text",
      "mandatory": false,
      "expectedValues": [
        "text"
      ],
      "validationExpressions": [
        {
          "expression": "text",
          "message": "text"
        }
      ]
    }
  ]
}

Useful Information

Campaign IDs are required for Submissions

Most of the time you'll be listing campaigns to find the ID of the appropriate campaign you wish to create a submission against or to check the progress of a historically created submission.

Expected Values

Expected values are configured against fields on the campaign. If any expected values exist, then the API will only accept the values within that list. For example, I might configure a DayOfTheWeek field on my campaign. If I do this I may configure the expected values "Monday","Tuesday","Wednesday","Thursday","Friday","Saturday" and "Sunday". This is intended to provide some basic validation to clients configuring their campaigns.

Validation Expressions

Validations are regex expressions and paired messages. When a record is received against the campaign ZAP will validate that all validation expressions are passed. If any fail, a list of errors will be compiled with the relevant message configured for the validation expression. This piece of functionality provides more advanced validation as the regex expressions can get quite complex.