Partially update data row in lookup table

Request

Security

OAuth2(Required scopes: enrichment.write)

Path

typestringrequired

type of data being updated

externalIdstringrequired

Previously sent externalId

Bodyapplication/merge-patch+jsonrequired

externalIdstringrequired

External id of the lookup-table-row that is globally unique across the provided lookup-table-row data

Example:"12345"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring

Number of the lookup table record in the source system (not unique across clients)

Example:"CODE1"

property name*string, <= 20 propertiesadditional property

externalClientId and code counts for maximum 20 additional properties

curl -i -X PATCH \
  'https://api.cloud.hypatos.ai/v2/enrichment/lookup-tables/{type}/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "externalId": "12345",
    "externalClientId": "EXTERNAL_CLIENT_ID",
    "dimension1": "someValue",
    "dimension2": "anotherValue",
    "customField": "dynamicValue"
  }'

Responses

Successfully updated

Bodyapplication/json

externalIdstringrequired

External id of the lookup-table-row that is globally unique across the provided lookup-table-row data

Example:"12345"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring

Number of the lookup table record in the source system (not unique across clients)

Example:"CODE1"

property name*string, <= 20 propertiesadditional property

externalClientId and code counts for maximum 20 additional properties

Response

{
  "externalId": "12345",
  "externalClientId": "EXTERNAL_CLIENT_ID",
  "dimension1": "someValue",
  "dimension2": "anotherValue",
  "customField": "dynamicValue"
}