Update Price List Document Description
PATCH/api/suppliers/:supplier/price-list/documents/:document
Updates a document's description — the only editable field. The stored file itself is immutable; upload a new document to replace it. Send description as null to clear it. Maximum 2000 characters.
suppliers:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns 404 when the document is not a price list document of this supplier.
Authentication: Requires Bearer token.
Requires scope: suppliers:write
Requires permission: suppliers.update
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
Response Headers
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.