Create a resident - Yorlet Documentation

curl --request POST \ --url https://api.yorlet.com/v1/loyalty/residents \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "building": "<string>", "email": "<string>", "name": "<string>", "tier": "<string>" } '

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

Authorizations

Authorization

string

header

required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json

building

string

required

The ID of the building to associate the resident with.

string

required

The resident's email address.

name

string

The resident's full name.

tier

string

The ID of the loyalty tier to assign the resident to.

Pattern: ^[a-zA-Z0-9_]+$

status

enum<string>

The status of the resident's membership.

Available options:

active,

inactive

Response

200 - application/json

Returns the created resident.

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.