Toggle Vendor Credit Note Pin
PUT/api/vendor-credits/:vendorCredit/notes/:noteId/toggle-pin
Toggle the pinned state of a note on a vendor credit. Pinned notes sort to the top of the note list. No request body is required.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns the updated note. Returns 404 when the note does not belong to the vendor credit.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.