get https://api.salesautopilot.com/v2/newsletter//events
GetSubscriberEventsAction
Response
Success Response Fields
Field | Type | Description |
---|---|---|
success | boolean | Indicates if the request was successful |
data | object | Contains the data of the response |
data.list_name | string | Name of the newsletter list |
data.page | int | Current page number |
data.pageCount | int | Total number of pages |
data.events | array | List of events |
data.events.[] | object | Properties of an event |
data.events.[].id | string | ID of the event |
data.events.[].email | string | Email of the subscriber |
data.events.[].happened_at | string | Timestamp of the event |
data.events.[].type | string | Type of the event. Possible values: - subscribe, - unsubscribe, - email_sent, - double_optin, - double_optin_confirm, - email_open, - email_click, - bounce, - soft_bounce, - sms_sent |
data.events.[].email_id | string | ID of the email if email related event |
data.events.[].letter_name | string | Name of the email, sms if email related event |
data.events.[].send_id | string | ID of the send if email related event |
data.events.[].subject | string | Subject of the email if email related event |
data.events.[].link | string | Link clicked (if type is email_click) |
Error Response Fields
Field | Type | Description |
---|---|---|
errorCode | int | Code of the error |
errorMessage | string | Human readable error message |
Error Codes
errorCode | Description |
---|---|
1 | JSON syntax error |
2 | Missing request body |
10100 | Parameter missing |
10101 | Parameter invalid |
1005 | Authorization header missing |
1006 | Token expired |