POST /v1/:facility_id/tenants/:tenant_id/notes
Create a new note on a tenant or unit.

POST /v1/:facility_id/notes
Create a new note on a tenant or unit.

Params

Param name Description
user_id
required

Validations:

  • Must be a String
note
required

Validations:

  • Must be a Hash
note[note_text]
required

Validations:

  • Must be a String
note[tenant_id]
optional

Validations:

  • Must be a String
note[ledger_id]
optional

Validations:

  • Must be a String
note[unit_id]
optional

Validations:

  • Must be a String

Examples

POST /v1/854321f3-f3d8-46a6-9362-1f3560321043/notes
{
  "note": {
    "note_text": "Don't trust his lies.",
    "tenant_id": "8d481e70-555e-4d60-8f99-b63a3a536ef8"
  }
}
200
{
  "note_event": {
    "id": "984c13ba-294b-405d-af41-b41ed465673c",
    "notes": [
      {
        "id": "fb9540e1-0806-4ee1-b8a6-8097373ca550",
        "note": "Don't trust his lies.",
        "created_at": "2023-09-15T04:39:29.582-10:00"
      }
    ],
    "created_by": {
      "id": "76800f30-e87e-41bf-8ad6-2df3409e9849",
      "name": "Test App",
      "type": "ClientApplication"
    },
    "unit_id": null,
    "tenant_id": "8d481e70-555e-4d60-8f99-b63a3a536ef8"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "note": {
        "note_text": "Don't trust his lies.",
        "tenant_id": "8d481e70-555e-4d60-8f99-b63a3a536ef8"
      },
      "facility_id": "854321f3-f3d8-46a6-9362-1f3560321043"
    }
  }
}