universe
PUT /data/{collectionName}/{indexName}/{indexValue}
Api key auth Bearer auth

Path parameters

  • collectionName string Required

    defines the collection on which you want to call the operation (e.g users)

  • indexName string Required

    defines the name of the index to query data on (most times you will need _id)

  • indexValue string Required

    defines the value of the index to query data on

application/json

Body

  • filter object

    use simple key value query parameters for additional filtering on the data object you want to update

    Hide filter attribute Show filter attribute object
    • * string Additional properties
  • authField string

    this parameter can be used to use a different item field other then the original field (userId). This field is used to map data objects to sub accounts.

  • values object Required

    you can provide any data you want for updating your data object

    Hide values attribute Show values attribute object
    • * string | number | boolean | object | array Additional properties

Responses

  • 200 application/json

    success

    Hide response attribute Show response attribute object
    • * string | number | boolean | object | array Additional properties
PUT /data/{collectionName}/{indexName}/{indexValue} 
curl \
 --request PUT 'https://api.universecloud.io/data/users/_id/64a1cc789f556f7ce46c576b' \
 --header "X-Api-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"filter":{"additionalProperty1":"string","additionalProperty2":"string"},"authField":"string","values":{"name":"baz quz"}}'
Request examples 
{
  "filter": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "authField": "string",
  "values": {
    "name": "baz quz"
  }
}
Response examples (200) 
{
  "_id": "64a1cc789f556f7ce46c576b",
  "age": 30,
  "name": "foo bar",
  "userId": "auth0|63dfc22f977173187654321"
}