Session

Unsubscribe sessions

Unsubscribe contacts by email and/or userId. Fire-and-forget: the response is always { "success": true } and does not reflect whether the contacts were found or updated. Every session in the project matching an entry's email OR userId is unsubscribed; entries with neither field are ignored.

POST

https://api.gleap.io/v3/sessions/unsubscribe

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Headers

projectstringrequired

Bodyapplication/jsonrequired

reasonstring

Stored as Session.unsubscribeReason. Defaults to "CSV upload" when omitted.

sessionsobject[]required

Show child attributes

userIdstring

emailstring

Response

application/json

successbooleanrequired

Updated November 1, 2026

curl --request POST \
  --url https://api.gleap.io/v3/sessions/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sessions": [
    {}
  ]
}'

{
  "success": true
}