Releva provides an API you can call to unsubscribe users.

Do I need to call it? #

You need to tell Releva when a user has unsubscribed so that they are excluded from marketing communication send through Releva.

Request Format #

The API accepts the following curl equivalent:

# using email
curl -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' -XPOST https://releva.ai/api/v0/unsubscribe -d'{ "email": "support@releva.ai" }'
# using phone number
curl -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' -XPOST https://releva.ai/api/v0/unsubscribe -d'{ "phoneNumber": "+1585123" }'

Response Format #

A successful request will return a JSON response with HTTP status 202 and an empty body ({}). If an error is encountered, an appropriate HTTP status code will be returned along with a body describing the error ({“message”: “…”})

If the email address in the request is not tracked in Releva, the request will have no effect.