v1

latestSwagger 2.02026-07-17332466.5 KB
elements

Update Element in list

Update element in list If element does not exist, it is created in list. Element ID in payload an url must match.

Required security scopes:

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

Path parameters

element_idstring required

ID of element

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

rangeinteger

Return this number of elements above and below the current element in neighbors field.

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
}

Response

OK