Create a resident
Create a resident
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The ID of the building to associate the resident with.
The resident's email address.
The resident's full name.
The ID of the loyalty tier to assign the resident to.
^[a-zA-Z0-9_]+$The status of the resident's membership.
active, inactive Response
Returns the created resident.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
resident The building the resident is associated with.
Whether the resident is linked to a OneMove account. pending means the OneMove user has been asked to confirm they live at the building, rejected means they declined, and none means no OneMove account matches the resident.
none, pending, linked, rejected The resident's email address.
The resident's full name.
How the resident was added. tenancy residents come from an active tenancy and are linked automatically, manual residents must be confirmed by the OneMove user.
manual, tenancy The loyalty tier the resident is assigned to.
The status of the resident's membership.
active, inactive The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.