> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/asset/update-asset-details.md). # Update asset details Update asset details. A partial write: a field left out keeps what the asset has, and serviceOrderUids follows its own description. Uploading a file changes only the file, never the record's other fields. A file in the SERVICE category is also open to a caller who holds SERVICE\_ORDER and not ASSET. The endpoint judges that alternative itself, from the file's category, which is why x-flow-permissions names ASSET alone: listed there, SERVICE\_ORDER would open every category. On that alternative the file's service orders — the ones it is on and the ones a request names — must all be owned by a store the caller holds SERVICE\_ORDER at; any other service order of the tenant is refused with a 403. Required permissions: ASSET ```json {"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Asset","description":"Asset"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"AssetResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetResponseSchema"}}}}},"schemas":{"AssetResponseSchema":{"title":"AssetResponseSchema","allOf":[{"required":["assetUid","name","description","category","isPublic","customerVisible","publicUrl","mimeType","size","serviceOrderUids"],"properties":{"assetUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"description":{"type":"string"},"category":{"$ref":"#/components/schemas/AssetCategoryENUM"},"isPublic":{"type":"boolean"},"customerVisible":{"type":"boolean","description":"Whether the file is shown to the customer: it is listed among the documents on their service portal page. False keeps it inside the workshop — the photo of the damage taken for the technician, the supplier's note.\nIt is independent of isPublic, which only says whether the file is fetched from the CDN without a signature. A file can be CDN-public and still internal, and a customer-visible file reaches the customer through its own document link on the portal page. A file fetched from the CDN without a signature (isPublic) or kept at an address of its own, a file outside the SERVICE category and a file attached to more than one service order are never listed on the portal, whatever this flag says."},"publicUrl":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"serviceOrderUids":{"type":"array","items":{"$ref":"#/components/schemas/UID"}}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}],"type":"object"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"AssetCategoryENUM":{"title":"AssetCategoryENUM","enum":["BRANDING","SERVICE","REPORT","OTHER"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"AssetUpdateRequestSchema":{"title":"AssetUpdateRequestSchema","type":"object","properties":{"name":{"type":"string"},"category":{"$ref":"#/components/schemas/AssetCategoryENUM"},"description":{"type":"string"},"isPublic":{"type":"boolean"},"customerVisible":{"type":"boolean","description":"Whether the file is shown to the customer: it is listed among the documents on their service portal page. It is meaningful on a SERVICE file attached to exactly one service order, which is the only place a customer ever reads one. False keeps it inside the workshop — the photo of the damage taken for the technician, the supplier's note. Left out, the asset keeps what it has.\nIt is independent of isPublic, which only says whether the file is fetched from the CDN without a signature. A file can be CDN-public and still internal, and a customer-visible file reaches the customer through its own document link on the portal page. A file fetched from the CDN without a signature (isPublic) or kept at an address of its own, a file outside the SERVICE category and a file attached to more than one service order are never listed on the portal, whatever this flag says."},"url":{"type":"string","description":"for self-hosted asset"},"serviceOrderUids":{"type":"array","description":"The service orders the file is attached to. Left out, the file keeps the service orders it is on, so a change of name or of customerVisible alone never detaches it. An empty array detaches it from all of them, and a list replaces the ones it is on. A caller who reaches this operation through SERVICE_ORDER rather than ASSET changes the service orders of a file only when every service order it is on and every one named is owned by a store they hold SERVICE_ORDER at; any other service order of the tenant is refused with a 403.","items":{"$ref":"#/components/schemas/UID"}}}}},"requestBodies":{"AssetUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/assets/{assetUid}":{"put":{"summary":"Update asset details","tags":["Asset"],"responses":{"200":{"$ref":"#/components/responses/AssetResponse"}},"operationId":"put-asset","description":"Update asset details. A partial write: a field left out keeps what the asset has, and serviceOrderUids follows its own description. Uploading a file changes only the file, never the record's other fields.\n\nA file in the SERVICE category is also open to a caller who holds SERVICE_ORDER and not ASSET. The endpoint judges that alternative itself, from the file's category, which is why x-flow-permissions names ASSET alone: listed there, SERVICE_ORDER would open every category. On that alternative the file's service orders — the ones it is on and the ones a request names — must all be owned by a store the caller holds SERVICE_ORDER at; any other service order of the tenant is refused with a 403.\n\nRequired permissions: ASSET","requestBody":{"$ref":"#/components/requestBodies/AssetUpdateRequest"}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.flowretail.com/docs/developers/api-documentation/asset/update-asset-details.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.