Skip to content

Stock note​

PUT
/resources/{id}/stock-note

"Fresh bread Tuesdays"; null clears it. Live at once, audit-logged with who.
Checks: requireProviderAccess('update_resource_capacity').

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Header Parameters

If-Match

The version you opened, e.g. "7". Or send version in the body.

Type
string

Path Parameters

id*

The resource.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"stock_note": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress