ZAP~POST
ZAP~POST API Documentation
Ask or search…
K
Links

Submissions

Submissions are collections of records that are submitted against a campaign. The records are made up of the required recipient information and the relevant campaign specific fields that have been configured in the ZAP APP The POST endpoints allow users to submit either an entire self contained collection of records intended to be sent together on a specific date or they can submit individual records after an appropriate event has occurred.
post
/api/v1/records
A common use case for the records endpoint would be to submit an individual record when a basket is abandoned for an e-com journey or for a customer quote request

Record Batching

Its very important to note that low volumes of records submitted to the ZAPI will be compiled into larger submissions at the end of each day. This is to reduce the total volume of submissions created against a campaign and make monitoring a much easier task for regularly scheduled campaigns. This means you won't be able to query for any updates on records submitted until the day after submission when they've been batched.
post
/api/v1/submissions
A common use case for this endpoint would be when adding a collection of related records such as a group of renewal reminders for a monthly send or a list of lapsed customers
Users can also list any submissions that exist against a campaign or list submissions actively working through the ZAP flow before being sent.
get
/api/v1/Submissions/{campaignId}
get
/api/v1/Submissions/Active/{campaignId}

Useful information

Scheduled Send Date selection

Any records or submissions sent to the ZAP API will be automatically included on the soonest available scheduled send if one is not specified. Unless you wish to use a specific send in the future it's most likely you don't need to specify the scheduled send on the request.

The OnlyValidRecords property

When creating a submission users have the option to set 'OnlyValidRecords' to true or false. When true the records in the submission will only be accepted if every record is valid. If 'OnlyValidRecords' is set to false, then any records that pass validation will be accepted and any that fail will not and will be returned in the usual response format detailing the validation failures.

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". Any records that fail because of an expected value will have the list of valid values returned in the error provided on submission.

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.

Default Field Validation

Property
Mandatory
ErrorMessage
Max Text Length
CustomerId
Yes
Must be unique
100
Email
No
be in standard email address format.
255
Salutation
No
Must be alphanumeric, full-stop and space only.
35
Firstname
Yes
Must be alphanumeric, space, -, (, ), full-stop and ' only.
35
Surname
Yes
Must be alphanumeric, space, -, (, ), full-stop and ' only.
35
Address1
Yes
Must contain alphanumeric, space, ', ., &, -, /, \, ), ( and , characters only.
35
Address2
No
Must contain alphanumeric, space, ', ., &, -, /, \, ), ( and , characters only.
35
Address3
No
Must contain alphanumeric, space, ', ., &, -, /, \, ), ( and , characters only.
35
City
No
Must contain alphanumeric, space, ', ., &, -, /, \ and , characters only.
255
Postcode
Yes
Must be alphanumeric, - and spaces only.
15
Country
Yes
Must contain letters, space, -, (, ), full-stop, & and ' only.
255
Currency
No
Must contain letters only.
3
Language
No
Must contain letters only.
10