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

Authorizations

AuthorizationstringRequired

Responses

200

Success

application/json

idstring · uuidOptional

clientIdstring · uuid · nullableOptional

namestring · nullableOptional

descriptionstring · nullableOptional

startDatestring · date-time · nullableOptional

durationinteger · int32 · nullableOptional

zapLimitinteger · int32 · nullableOptional

csvPathstring · nullableOptional

enabledboolean · nullableOptional

statusstring · nullableOptional

paperStockIdstring · uuid · nullableOptional

zapsSentinteger · int32 · nullableOptional

archivedDatestring · date-time · nullableOptional

templateIdstring · uuid · nullableOptional

sampleDataCsvBlobUrlstring · nullableOptional

400

Bad Request

401

Unauthorized

500

Server Error

get/api/v1/campaigns

GET /api/v1/campaigns HTTP/1.1
Authorization: Basic username:password
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "startDate": "2026-01-01T00:00:00.000Z",
    "duration": 1,
    "zapLimit": 1,
    "csvPath": "text",
    "enabled": true,
    "status": "text",
    "paperStockId": "123e4567-e89b-12d3-a456-426614174000",
    "zapsSent": 1,
    "archivedDate": "2026-01-01T00:00:00.000Z",
    "templateId": "123e4567-e89b-12d3-a456-426614174000",
    "sampleDataCsvBlobUrl": "text"
  }
]

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

Authorizations

AuthorizationstringRequired

Path parameters

campaignIdstring · uuidRequired

Responses

200

Success

application/json

idstring · uuidOptional

namestring · nullableOptional

descriptionstring · nullableOptional

startDatestring · date-time · nullableOptional

statusstring · nullableOptional

paperStockNamestring · nullableOptional

paperStockIdstring · nullableOptional

frontPublishedDesignstring · nullableOptional

backPublishedDesignstring · nullableOptional

401

Unauthorized

get/api/v1/campaign/{campaignId}

GET /api/v1/campaign/{campaignId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "startDate": "2026-01-01T00:00:00.000Z",
  "status": "text",
  "paperStockName": "text",
  "paperStockId": "text",
  "frontPublishedDesign": "text",
  "backPublishedDesign": "text",
  "fields": [
    {
      "name": "text",
      "description": "text",
      "label": "text",
      "exampleValue": "text",
      "mandatory": true,
      "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.