Tenant Created & Updated

{
"user_id": 35,
"user_type": "tenant",
"name": "George Washington",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sms_enabled": 1,
"email_enabled": 1,
"critical_note": "Do not call - only text",
"role_id": 5,
"availability": [
  {
    "date": "2019-08-24T14:15:22Z",
    "scheduled_start": "2019-08-24T14:15:22Z",
    "scheduled_end": "2019-08-24T14:15:22Z"
  }
],
"pw_id": null,
"avatar_url": null,
"ref_user_id": null,
"is_active": 1,
"company_id": null,
"st_cid": null,
"st_status": null,
"integration_data": null,
"slug": "d53u2"
}

Request Body schema: application/json

user_id

integer

Unique ID for Resident

user_type

string

Type of user (in the case of residents, this is always “Tenant”)

name

string

The user’s name

created_at

string

string <date-time>

updated_at

string

string <date-time>

sms_enabled

integer

Boolean to describe whether the user has opted into SMS text messaging communication

email_enabled

integer

Boolean to describe whether the user has opted into email communication

critical_note

string

Critical note to provide context for Latchel operations response

role_id

integer

Unique ID for user role

availability

array

A list of available times the resident has indicated availability

pw_id

integer

default:"null"

The resident’s PropertyWare ID (if exists)

avatar_url

string

default:"null"

URL for the resident’s avatar

ref_user_id

string

default:"null"

Tenant’s reference user ID

is_active

integer

Boolean to describe whether the user is active in Latchel or not

company_id

integer

default:"null"

Unique ID for PM Company who manages this resident

st_cid

integer

default:"null"

Unique ID for resident’s Stripe account

st_status

integer

default:"null"

Status of resident’s Stripe account

integration_data

json

default:"null"

Data corresponding to resident’s third party integrations

slug

string

A human-readable unique identifier for the resident

Response

200

Return a 200 status to indicate that the data was received successfully

{
"user_id": 35,
"user_type": "tenant",
"name": "George Washington",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sms_enabled": 1,
"email_enabled": 1,
"critical_note": "Do not call - only text",
"role_id": 5,
"availability": [
  {
    "date": "2019-08-24T14:15:22Z",
    "scheduled_start": "2019-08-24T14:15:22Z",
    "scheduled_end": "2019-08-24T14:15:22Z"
  }
],
"pw_id": null,
"avatar_url": null,
"ref_user_id": null,
"is_active": 1,
"company_id": null,
"st_cid": null,
"st_status": null,
"integration_data": null,
"slug": "d53u2"
}

{
"user_id": 35,
"user_type": "tenant",
"name": "George Washington",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sms_enabled": 1,
"email_enabled": 1,
"critical_note": "Do not call - only text",
"role_id": 5,
"availability": [
  {
    "date": "2019-08-24T14:15:22Z",
    "scheduled_start": "2019-08-24T14:15:22Z",
    "scheduled_end": "2019-08-24T14:15:22Z"
  }
],
"pw_id": null,
"avatar_url": null,
"ref_user_id": null,
"is_active": 1,
"company_id": null,
"st_cid": null,
"st_status": null,
"integration_data": null,
"slug": "d53u2"
}

{
"user_id": 35,
"user_type": "tenant",
"name": "George Washington",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sms_enabled": 1,
"email_enabled": 1,
"critical_note": "Do not call - only text",
"role_id": 5,
"availability": [
  {
    "date": "2019-08-24T14:15:22Z",
    "scheduled_start": "2019-08-24T14:15:22Z",
    "scheduled_end": "2019-08-24T14:15:22Z"
  }
],
"pw_id": null,
"avatar_url": null,
"ref_user_id": null,
"is_active": 1,
"company_id": null,
"st_cid": null,
"st_status": null,
"integration_data": null,
"slug": "d53u2"
}

Request Body schema: application/json

user_id

integer

Unique ID for Resident

user_type

string

Type of user (in the case of residents, this is always “Tenant”)

name

string

The user’s name

created_at

string

string <date-time>

updated_at

string

string <date-time>

sms_enabled

integer

Boolean to describe whether the user has opted into SMS text messaging communication

email_enabled

integer

Boolean to describe whether the user has opted into email communication

critical_note

string

Critical note to provide context for Latchel operations response

role_id

integer

Unique ID for user role

availability

array

A list of available times the resident has indicated availability

pw_id

integer

default:"null"

The resident’s PropertyWare ID (if exists)

avatar_url

string

default:"null"

URL for the resident’s avatar

ref_user_id

string

default:"null"

Tenant’s reference user ID

is_active

integer

Boolean to describe whether the user is active in Latchel or not

company_id

integer

default:"null"

Unique ID for PM Company who manages this resident

st_cid

integer

default:"null"

Unique ID for resident’s Stripe account

st_status

integer

default:"null"

Status of resident’s Stripe account

integration_data

json

default:"null"

Data corresponding to resident’s third party integrations

slug

string

A human-readable unique identifier for the resident

Response

200

Return a 200 status to indicate that the data was received successfully

{
"user_id": 35,
"user_type": "tenant",
"name": "George Washington",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sms_enabled": 1,
"email_enabled": 1,
"critical_note": "Do not call - only text",
"role_id": 5,
"availability": [
  {
    "date": "2019-08-24T14:15:22Z",
    "scheduled_start": "2019-08-24T14:15:22Z",
    "scheduled_end": "2019-08-24T14:15:22Z"
  }
],
"pw_id": null,
"avatar_url": null,
"ref_user_id": null,
"is_active": 1,
"company_id": null,
"st_cid": null,
"st_status": null,
"integration_data": null,
"slug": "d53u2"
}

{
"user_id": 35,
"user_type": "tenant",
"name": "George Washington",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sms_enabled": 1,
"email_enabled": 1,
"critical_note": "Do not call - only text",
"role_id": 5,
"availability": [
  {
    "date": "2019-08-24T14:15:22Z",
    "scheduled_start": "2019-08-24T14:15:22Z",
    "scheduled_end": "2019-08-24T14:15:22Z"
  }
],
"pw_id": null,
"avatar_url": null,
"ref_user_id": null,
"is_active": 1,
"company_id": null,
"st_cid": null,
"st_status": null,
"integration_data": null,
"slug": "d53u2"
}

​Request Body schema: application/json

​Response

API Documentation

​Request Body schema: application/json

​Response

Request Body schema: application/json

Response

Request Body schema: application/json

Response