This API allows you to read and update the list of unsubscribed emails.
Note: There is no limit to the number of users you can add to this list.
Read list of unsubscribed emails
GET https://app.satismeter.com/api/v2/project-unsubscribes/<PROJECT_ID>
-
Replace <PROJECT_ID> with your project ID (see Integration settings / API)
Request Headers:
Authorization: Bearer API_KEY
- Replace the API_KEY above with your real API key (see Integration Settings / API)
Response Body:
{
"data": {
"id": "PROJECT_ID",
"type": "project-unsubscribes",
"attributes": {
"emails": ["elon@tesla.com"]
}
}
}
The {data.attributes.emails} key contains a list of unsubscribed emails.
Update list of unsubscribed emails
PATCH https://app.satismeter.com/api/v2/project-unsubscribes/<PROJECT ID>
-
Replace PROJECT_ID with your project ID (see Integration settings / API)
Request Headers:
Authorization: Bearer API_KEY
Content-Type: application/json
- Replace the API_KEY above with your real API key (see Integration Settings / API)
Request Body:
{
"data": {
"id": "PROJECT ID",
"type": "project-unsubscribes",
"attributes": {
"emails": ["elon@tesla.com", "bill@microsoft.com"]
}
}
}
-
You can add new unsubscribed emails to the {data.attributes.emails} key.