Sign in

v1

latestSwagger 2.02026-07-17332466.5 KB
elements

Update Multiple Elements

Update Multiple Elements in list.If element does not exist, it is created in list. The returned "not_found" field will never be preset.

Required security scopes:

  • api:update
put/lists/{list_id}/elements

Path parameters

list_idstring required

The ID of the list to apply the operation on. Can be a to z (both upper/lower case), 0 to 9 or one of these characters _-.

Query parameters

resultsboolean

Return results of the operation. If disabled, operations will be faster and require less memory.

Request body

idinteger required

ID of element

payloadobject

Custom payload. Stored untouched. On updates null means do not update. {} is the empty value.

scoreinteger required

Score of the element. Higher score gives higher placement.

tie_breakerinteger

Tie breaker, used if score matches for consistent sorting. Higher value = higher placement if score is equal.

Example request

[
  {
    "id": 100,
    "payload": {
      "country": "dk",
      "name": "Mark Anthony"
    },
    "score": 100,
    "tie_breaker": 2000
  },
  {
    "id": 100,
    "payload": {
      "country": "dk",
      "name": "Mark Anthony"
    },
    "score": 100,
    "tie_breaker": 2000
  },
  {
    "id": 100,
    "payload": {
      "country": "dk",
      "name": "Mark Anthony"
    },
    "score": 100,
    "tie_breaker": 2000
  }
]

Response

OK