v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-142616180.5 KB

Score

Update score by field

Updates the score of a specific Score2 type field. Learn more about Data entity field types.

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
Dynamic Storage	Dynamic storage generic resources	Insert or update document (not remove)
Dynamic Storage	Dynamic storage generic resources	Full access to all documents
Dynamic Storage	Dynamic storage generic resources	Master Data administrator

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/dataentities/{acronym}/documents/{id}/score/{field-name}

Path parameters

acronymstring required

Example:SP

Two-letter string that identifies the data entity.

idstring required

Example:SP-b818cbda-e489-11e6-94f4-0ac138d2d42e

Unique identifier of the document.

field-namestring required

Example:carttag

Name of the field to score.

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

keystring required

Key name.

pointinteger required

Amount of points to be added to the score.

untilstring required

Amount of time the added points will be valid for.

Example request

{
  "key": "Payment",
  "point": 1,
  "until": "10m"
}

Response

No Content