v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB

Attachment

Update attachment

Updates a previously existing SKU attachment with new information.

⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Options documentation.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Catalog	Configuration	CMS Management

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

put/api/catalog/pvt/attachment/{attachmentid}

Path parameters

attachmentidstring required

Example:vtexcommercestable

Attachment ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

Namestring required

Attachment name.

IsRequiredboolean required

Defines if the attachment is required or not.

IsActiveboolean required

Defines if the attachment is active or not.

Example request

{
  "Name": "Shirt customization",
  "Domains": [
    {
      "FieldName": "Number",
      "MaxCaracters": "1",
      "DomainValues": "7,9,10"
    }
  ]
}

Response

Idinteger required