The resident object - Yorlet Documentation

{
  "id": "<string>",
  "created": 123,
  "object": "resident",
  "building": "<string>",
  "email": "<string>",
  "name": "<string>",
  "tier": "<string>",
  "account": "<string>",
  "deleted": false
}

string

required

Unique identifier for the object.

created

number

required

Time at which the object was created. Measured in seconds since the Unix epoch.

object

enum<string>

required

Available options:

resident

building

required

The building the resident is associated with.

string

required

The resident's email address.

name

string | null

required

The resident's full name.

tier

required

The loyalty tier the resident is assigned to.

status

enum<string>

required

The status of the resident's membership.

Available options:

active,

inactive

account

string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted

boolean

default:false

Only returned if the object has been deleted.

List all loyalty programs

Create a resident