This API allows you to read and update the list of unsubscribed emails.

Read list of unsubscribed emails

GET https://app.satismeter.com/api/v2/project-unsubscribes/<PROJECT_ID>
  • Authorization: basic auth (username, password)
  • Replace <PROJECT_ID> with your project ID (see Integration settings / API)

Response Body:

{
    "data": {
        "id": "PROJECT_ID",
        "type": "project-unsubscribes",
        "attributes": {
            "emails": ["elon@tesla.com"]
        }
    }
}

The data.attributes.emails  key contains list of unsubscribes emails.

Update list of unsubscribed emails

PATCH https://app.satismeter.com/api/v2/project-unsubscribes/<PROJECT ID>
  • Authorization: basic auth (username, password)
  • Replace PROJECT_ID with your project ID (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.
Did this answer your question?