Unsubscribe email API

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

Note: There's no limit to the number of users you can add to this list.

Reading the list of unsubscribed emails

Send this request to read the list:

GET https://app.satismeter.com/api/v2/project-unsubscribes/<PROJECT_ID>

• Replace <PROJECT_ID> with your project ID. You can find it in Integration settings > API.

Request headers

Include this header in the request:

Authorization: Bearer API_KEY

• Replace API_KEY with your API key. You can find it in Integration settings > API.

Response body

The response looks like this:

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

The data.attributes.emails key contains the list of unsubscribed emails.

Updating the list of unsubscribed emails

Send this request to update the list:

PATCH https://app.satismeter.com/api/v2/project-unsubscribes/<PROJECT ID>

• Replace <PROJECT ID> with your project ID. You can find it in Integration settings > API.

Request headers

Include these headers in the request:

Authorization: Bearer API_KEY
Content-Type: application/json

• Replace API_KEY with your API key. You can find it in Integration settings > API.

Request body

Send a request body like this:

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

• Add new unsubscribed emails to the data.attributes.emails key.