Skip to content

Area: Developers

POST

Unsubscribe a profile

Path
/unsubscribe
Auth
Secret key · server only
POST
/unsubscribe
curl --request POST \
--url https://releva.ai/api/v0/unsubscribe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "maria@example.com" }'

Opts the profile out shop-wide (subscribedAt cleared, unsubscribedAt set) and removes your shop’s user-visible subscriptions from it. Subscriptions you only set through the API are kept. An unknown email or phone number creates a new profile that is unsubscribed. Email, SMS, Viber and WhatsApp stop for an unsubscribed profile; push, Facebook Ads and Google Ads audiences do not check the opt-out, so segment those on subscription status too. Unknown fields are rejected.

Media typeapplication/json

Send at least one of email or phoneNumber. Unknown fields are rejected.

object
email
string format: email
phoneNumber
string
>= 2 characters <= 32 characters /^\+\d+$/
attributions

Links the event to the message or campaign that caused it. All values are ids as strings.

object
emailId
string
campaignId
string
textMessageId
string
viberMessageId
string
whatsappMessageId
string

Example

{
"email": "maria@example.com"
}

Accepted for asynchronous processing.

Media typeapplication/json
object
0

Example

{}

Authentication or validation error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Authorization header is missing."
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Domain is disabled. Please reach out to support@releva.ai to enable it."
}

Request body larger than 800 KB.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "request entity too large"
}