Skip to content
Vespy API

Update tenant by id

PUT
/api/tenants/{id}
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 '{ "billingAddress": { "city": "example", "country": "example", "line1": "example", "line2": "example", "postalCode": "example", "state": "example" }, "dbaName": "example", "email": "hello@example.com", "emergencyContactName": "example", "emergencyContactPhone": "example", "emergencyContactRelationship": "example", "fullName": "example", "isActive": true, "kind": "person", "legalName": "example", "phone": "example", "preferredLanguage": "example", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Any of:
object
billingAddress
object
city
required
string
>= 1 characters <= 120 characters
country
required
string
>= 2 characters <= 2 characters
line1
required
string
>= 1 characters <= 160 characters
line2
string
nullable >= 1 characters <= 160 characters
postalCode
required
string
>= 1 characters <= 20 characters
state
required
string
>= 1 characters <= 80 characters
dbaName
string
nullable
email
required
string format: email
emergencyContactName
string
nullable
emergencyContactPhone
string
nullable
emergencyContactRelationship
string
nullable
fullName
string
>= 1 characters <= 160 characters
isActive
boolean
kind
string
Allowed values: person company
legalName
string
nullable
phone
string
nullable
preferredLanguage
string
>= 2 characters <= 32 characters
userId
string format: uuid
nullable

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/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
id
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
id
required
string format: uuid
visibility
required
string
Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared
tenant
required
object
billingAddress
required
object
city
required
string
>= 1 characters <= 120 characters
country
required
string
>= 2 characters <= 2 characters
line1
required
string
>= 1 characters <= 160 characters
line2
string
nullable >= 1 characters <= 160 characters
postalCode
required
string
>= 1 characters <= 20 characters
state
required
string
>= 1 characters <= 80 characters
createdAt
required
string format: date-time
dbaName
required
string
nullable
deletedAt
required
string format: date-time
nullable
email
required
string format: email
nullable
emergencyContactName
required
string
nullable
emergencyContactPhone
required
string
nullable
emergencyContactRelationship
required
string
nullable
fullName
required
string
>= 1 characters <= 160 characters
id
required
string format: uuid
isActive
required
boolean
kind
required
string
Allowed values: person company
legalName
required
string
nullable
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"
    }
  ],
  "tenant": {
    "kind": "person"
  }
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Section titled “409”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}