API ReferencePoints

Set payload

Sets payload values for specified points.

Path parameters

collection_namestringRequired
Name of the collection to set from

Headers

api-keystringRequired

Query parameters

waitbooleanOptional
If true, wait for changes to actually happen
orderingenumOptional
define ordering guarantees for the operation
Allowed values:

Request

This endpoint expects an object.
payloadmap from strings to anyRequired
pointslist of uint64s or stringsOptional
Assigns payload to each point in this list
filterobject or anyOptional
Assigns payload to each point that satisfy this filter condition
shard_keystring or uint64 or list of strings or uint64s or anyOptional
keystringOptional
Assigns payload to each point that satisfy this path of property

Response

successful operation
usageobject or any or null
timedouble or null
Time spent to process this request
statusstring or null
resultobject or null