Create a note on an entity

POST

/api/notes

curl --request POST \
  --url https://api.getvespy.com/api/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "entityType": "property", "visibility": "organization_only" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

body

required

string

>= 1 characters <= 4000 characters

entityId

required

string format: uuid

entityType

required

string

Allowed values: property unit owner tenant lease vendor work_order

visibility

required

string

Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared

Responses

201

Default Response

Media typeapplication/json

object

note

required

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

Example

{
  "note": {
    "entityType": "property",
    "visibility": "organization_only"
  }
}

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

Example^generated

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

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

Example^generated

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

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

Example^generated

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

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

Example^generated

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