Toggle Sales Order Note Pin

PUT 
/api/sales-orders/:salesOrder/notes/:noteId/toggle-pin

Toggles the pinned state of a sales order note. Pinned notes surface at the top of the order's notes.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Behavior:

• Flips is_pinned and returns the updated note with its author.
• The response message is "Note pinned" or "Note unpinned" depending on the new state.
• Returns 404 if the note does not exist on this sales order.

Path parameters:

• salesOrder (required): Sales order ID.
• noteId (required): Note ID.

Requires permission: sales_orders.update

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not Found

Response Headers

Content-Type

422

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.

429

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.