Update tenant by id

PUT

/api/tenants/{id}

const url = 'https://api.getvespy.com/api/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"hello@example.com","emergencyContactName":"example","emergencyContactPhone":"example","emergencyContactRelationship":"example","fullName":"example","isActive":true,"phone":"example","preferredLanguage":"example","userId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://api.getvespy.com/api/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "emergencyContactName": "example", "emergencyContactPhone": "example", "emergencyContactRelationship": "example", "fullName": "example", "isActive": true, "phone": "example", "preferredLanguage": "example", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

Request Body^required

application/json

Any of:

object

email

required

string format: email

emergencyContactName

string

nullable

emergencyContactPhone

string

nullable

emergencyContactRelationship

string

nullable

fullName

string

>= 1 characters <= 160 characters

isActive

boolean

phone

string

nullable

preferredLanguage

string

>= 2 characters <= 32 characters

userId

string format: uuid

nullable

Example^generated

{
  "email": "hello@example.com",
  "emergencyContactName": "example",
  "emergencyContactPhone": "example",
  "emergencyContactRelationship": "example",
  "fullName": "example",
  "isActive": true,
  "phone": "example",
  "preferredLanguage": "example",
  "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

Default Response

application/json

object

notes

required

Array<object>

object

body

required

string

>= 1 characters <= 4000 characters

createdAt

required

string format: date-time

createdByUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

required

string format: uuid

createdByUserId

required

string format: uuid

nullable

entityId

required

string format: uuid

entityType

required

string

Allowed values: property unit owner tenant lease vendor work_order

required

string format: uuid

visibility

required

string

Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared

tenant

required

object

createdAt

required

string format: date-time

deletedAt

required

string format: date-time

nullable

email

required

string format: email

emergencyContactName

required

string

nullable

emergencyContactPhone

required

string

nullable

emergencyContactRelationship

required

string

nullable

fullName

required

string

>= 1 characters <= 160 characters

required

string format: uuid

isActive

required

boolean

organizationId

required

string format: uuid

phone

required

string

nullable

preferredLanguage

required

string

>= 2 characters <= 32 characters

userId

required

string format: uuid

nullable

Example

{
  "notes": [
    {
      "entityType": "property",
      "visibility": "organization_only"
    }
  ]
}

400

Default Response

application/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

application/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

application/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

application/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Default Response

application/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

Update tenant by id

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated