Notes | Heeler User Guide

Get Resource Notes By Id

get

Authorizations

Path parameters

resource_idstringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/notes/{resource_id}

GET /api/notes/{resource_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "created": "2025-11-04T18:20:37.623Z",
    "heeler_id": "text",
    "email": "text",
    "note": "text"
  }
]

Create Resource Note

post

Authorizations

Path parameters

resource_idstringRequired

Body

notestringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/notes/{resource_id}

POST /api/notes/{resource_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "note": "text"
}

{
  "ok": true,
  "message": "text"
}

Delete Resource Note

delete

Authorizations

Path parameters

note_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

/api/notes/{note_id}

DELETE /api/notes/{note_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}