Skip to main content
GET
/
people
/
{personIdOrEmail}
/
opted-out
Get a person's opted out status by ID or email
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/people/{personIdOrEmail}/opted-out \
  --header 'Authorization: Bearer <token>'
{
  "personId": "<string>",
  "email": "<string>",
  "isOptedOut": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.rallyuxr.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
personIdOrEmail
required

The id or email of the person. The id is the internal id of the person or if the email passed is valid then it will be used for lookup

Example:

"cm0b4eokq000vbbsimwelll3u"

Response

The person

​
personId
string
required

The ID of the person

​
email
string
required

The email of the person

​
isOptedOut
boolean
required

Whether the person is opted out of research