Choose the right postage when sending on the API Are you sending personal information, or marketing content? Before you send your mail, know the key difference between First-Class and USPS Marketing Mail. Read our blog to find out more.
Create a recipient event
A recipient event can be used for tracking campaign engagement and conversions. Events can also be recorded so communication can be triggered automatically.
[POST]
https://api-us1.stannp.com/v1/recipientEvents/create
Parameters
| Parameter | Details | Description |
|---|---|---|
| recipient_id | str required | An id of the recipient. This needs to be the recipient_id or the alternative reference id which can be used to match an id from a different system. |
| name | str required | Name the event. For example: PURCHASE, SIGNUP, PAGE_VIEW, PRODUCT_VIEW, PRODUCT_TO_BASKET. |
| value | str optional | Add value information. For example, the value of the purchase or the product name. |
| conversion | bool optional | True or false. Is this a conversion event (e.g., purchasing or a signup)? Defaults to false. |
| data | str optional | Any extended data you wish to store about this event for automation tasks or dynamic templating. |
| ref | str optional | Can be a campaign reference id or a mailpiece reference id. If left empty, we will use any recent communication to allocate as a reference. |
Request Example
curl "https://api-us1.stannp.com/v1/recipientEvents/create" \
-u {API_KEY}: \
-d "name=PURCHASE" \
-d "value=24.99" \
-d "conversion=true" \
-d "recipient_id=12345"
Response Example
{
"success": true,
"data": 266
}