Skip to content

Update Custom Entity

Request

Updates an existing item of a Custom Entity type, identified by its denominator and item identifier, applying PATCH semantics so that only the supplied fields are modified. Returns 200 OK when the update is applied.

Authentication

Requires a valid API key in the X-API-KEY header.

Headers

Accept-Language

Culture used to interpret the localized field values supplied in the request body.

  • omitted / null: tenant's default culture.
  • culture-code (e.g. en-US, es): the specified culture.

Request Body

A single JSON object with the subset of writable fields to update (PATCH semantics — only the supplied fields are modified). Field names must match those published by /CustomEntities('{denominator}')/$metadata. Normalization rules:

  • Must be a non-empty JSON object.
  • A JSON array is accepted only if it contains exactly one element.
  • Values are coerced to CLR primitives, nested objects and arrays.
  • A date attribute is a date and time with no time zone, stored and returned as written ("2026-10-21T16:22:00"). A value with Z or an offset (2026-10-21T14:22:00Z) is converted to its date and time in Spain (Europe/Madrid), the time the app shows (2026-10-21T16:22:00). System dates (_creation, _modify) are set by the service.

Response

204 No Content — Update applied. The response has no body.

Error Responses

  • 400 Bad Request — The body cannot be written: empty, an array of more than one object, an attribute the entity does not have, one that cannot be assigned or a value the attribute does not take. Answered as a message naming why, a JSON string ("Value: ZZ not allowed", "Invalid attribute name: nope_field").
  • 401 Unauthorized — Missing or invalid API key. Returned by the API gateway as { "message": "Unauthorized", "request_id": "d8aafa5b8f3e400b60bea0123dd33317" }.
  • 403 Forbidden — The API key does not have write permissions for this operation.
  • 404 Not Found — Custom Entity denominator or item with the given identifier does not exist.
  • 500 Internal Server Error — Unexpected technical error.

Example

Request:

PATCH /CustomEntities('Brand')/item(42) HTTP/1.1
X-API-KEY: your-api-key-here
Accept-Language: en-US
Content-Type: application/json
            
{
  "abcd_description": "Updated description"
}

Response:

HTTP/1.1 204 No Content
Path
customEntityDenominatorstringrequired

Custom Entity denominator (natural language name from the PIM)

itemIdinteger, (int32)required

Custom Entity item identifier

Headers
X-API-KEYstring

Tenant's API key (required)

Accept-Languagestring

Culture for localized field values in the request body (Accept-Language header)

Bodyapplication/json

JSON object with the Custom Entity item fields to update

any
curl -i -X PATCH \
  'https://api2.saleslayer.com/catalog/CustomEntities('\''{customEntityDenominator}'\'')/item({itemId})' \
  -H 'Accept-Language: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: string'

Responses

No Content

Response
No content