Sign in

v3

latestOpenAPI 3.0.3raw.githubusercontent.com2026-04-279152.1 KB
Points

Set payload

Merge payload fields onto existing points identified by ID. Existing payload fields that are not specified in the request are preserved.

post/collections/{collection_name}/points/payload

Path parameters

collection_namestring required

The name of the collection containing the target points.

Request body

payloadobject required

Key-value pairs to set on the matching points.

Example request

{
  "payload": {
    "color": "red",
    "featured": true
  },
  "points": [
    1,
    2,
    3
  ]
}

Response

Payload set

timenumber double

Time spent to process this request, in seconds.

statusstring

Operation status. Returns ok on success.

Example response

{
  "time": 0.000102816,
  "status": "ok",
  "result": {
    "status": "Completed"
  }
}