Update Stock Take Attachment Description
PATCH/api/stock-takes/:stockTake/documents/:document
Updates an attachment's description. The description is the only editable field — the stored file itself is immutable, so upload a new attachment to replace it.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
description is required in the body and may be null to clear it. Maximum 2000 characters.
Returns 404 if the document is not attached to the given stock take.
Authentication: Requires Bearer token.
Requires scope: inventory:write
Requires permission: inventory.count
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.