People

Update a person's opted out status

Pass either the person ID or email to update the opted out status

put/people/{personIdOrEmail}/opted-out

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/people/{personIdOrEmail}/opted-out
  • Auth: HTTP bearer

Path parameters

string required

The ID of the person

OR
string email required

The email of the person

Request body

isOptedOutboolean required

Whether the person is opted out of research

Response

The person

personIdstring required

The ID of the person

isOptedOutboolean required

Whether the person is opted out of research

updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.