multilist

Create elements in multiple lists

Create elements in lists

Required security scopes:

  • api:update
post/xlist/elements

Request

Query parameters

errors_onlyboolean

Returns errors only. If disabled, operations will be faster and require less memory.

resultsboolean

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

Request body

all_in_setsstring[]

Include all lists in these sets

listsstring[]

Include lists that match exact list names

match_metadataobject

Include lists that match all values in metadata

Example request

{
  "all_in_sets": [
    "storage-set",
    "backup-set"
  ],
  "lists": [
    "highscore-dk-all",
    "highscore-uk-all"
  ],
  "match_metadata": {
    "country": "dk"
  },
  "payload": [
    {
      "id": 100,
      "payload": {
        "country": "dk",
        "name": "Mark Anthony"
      },
      "score": 100,
      "tie_breaker": 2000
    }
  ]
}

Response

OK

errorsobject

Failed operations, indexed by list IDs

successobject

Successful operations, indexed by list IDs

Example response

{
  "errors": {
    "highscore-dk-all": "not found"
  },
  "success": {
    "highscore-uk-all": {}
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.