Skip to main content
PUT
Set a person's contact preferences

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

person_id
string
required

The person's ID.

Body

application/json

At least one of the two.

opted_in
boolean

false opts the person out of all email. true opts them back in.

categories
object

Category names as your messages use them, such as general. false opts out of that category; true opts back in.

Response

The preferences, as they now are.

person_id
string
required
channel
enum<string>
required
Available options:
email
opted_in
boolean
required

false means the person has opted out of email from your organization altogether.

categories
object
required

Opt-outs by category. A category set to false is one the person does not want; a category not listed is allowed.

id
string | null

Null when nothing has been saved for this person.

tenant_id
string

Your organization's ID.

updated_at
string | null

Null when nothing has been saved.