PUT
/
people
/
{personIdOrEmail}
/
opted-out
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

Examples:

"cm0b4eokq000vbbsimwelll3u"

"dev@rallyuxr.com"

Body

application/json

Response

200
application/json
The person

The response is of type object.