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/sessions/unsubscribe

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/sessions/unsubscribe
  • Auth
    HTTP bearer

Headers

projectstring required

Request body

reasonstring

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

Response

Ok

successboolean required

Changes

No recorded changes to this operation across all 56 revisions of this API.