PUT
/
people
/
{personIdOrEmail}
/
opted-out
Update a person's opted out status
curl --request PUT \
  --url https://api.rallyuxr.com/api/public/v1/people/{personIdOrEmail}/opted-out \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "isOptedOut": true
}'
{
  "personId": "<string>",
  "isOptedOut": true,
  "updatedAt": "2023-11-07T05:31:56Z"
}

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 The ID of the person

Examples:

"cm0b4eokq000vbbsimwelll3u"

"dev@rallyuxr.com"

Body

application/json
isOptedOut
boolean
required

Whether the person is opted out of research

Response

The person

personId
string
required

The ID of the person

isOptedOut
boolean
required

Whether the person is opted out of research

updatedAt
string<date-time>
required