Skip to content
API Reference
/
/
Update Custom Entity

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.

Response

200 OK — Update applied.

Error Responses

  • 400 Bad Request — Payload normalization or validation failure (returns ValidationFailureRepresentation for validation errors).
  • 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 200 OK
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
PATCH
/CustomEntities('{customEntityDenominator}')/item({itemId})
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

OK

Bodyapplication/json
valueany or null
Response
{
  "readLink": {
    "uri": "http://example.com"
  },
  "value": null
}