Authentication

Include the API key in the Authorization header of all API requests:

Authorization: <YOUR_API_KEY>

🔑
To generate the API Key follow the instructions outlined here. The API key is required for all authenticated requests. Make sure to keep it secure and do not share.

Sample Request Payloads

{
  "NPI": "1987654321",
  "CampaignId": "123",
  "Token": "1A23B456-1111-2222-3333-A12B3C4D5E6F",
  "Custom1": "P-12345"
}

{
  "NPI": "9876543210",
  "CampaignId": "2345",
  "Token": "A123B456-1111-2222-3333-1A2B3C4D5E6F",
  "IsTest": true,
  "TestEmail": "developer.test@example.com",
  "Custom1": "Q2 Newsletter Preview",
  "Custom2": "Internal Test"
}

👍
When the API request is successful and the triggered email is successfully queued, a 'requestId' is returned in the response. ThisrequestIdcan be used to track and retrieve all engagement data related to the request.

Authentication

To generate the API Key follow the instructions outlined here. The API key is required for all authenticated requests. Make sure to keep it secure and do not share.

Sample Request Payloads

When the API request is successful and the triggered email is successfully queued, a 'requestId' is returned in the response. ThisrequestIdcan be used to track and retrieve all engagement data related to the request.

When the API request is successful and the triggered email is successfully queued, a 'requestId' is returned in the response. This`requestId`can be used to track and retrieve all engagement data related to the request.