Overwrite payload

PUT

Replaces the entire payload of a specified point with a new payload.

Path parameters

collection_namestringRequired

Name of the collection to set from

Query parameters

waitbooleanOptional

If true, wait for changes to actually happen

orderingenumOptional

define ordering guarantees for the operation

Allowed values: weakmediumstrong

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

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

PUT

1 # Overwrite payload by ID
2 curl  -X PUT \
3   'http://localhost:6333/collections/collection_name/points/payload' \
4   --header 'api-key: <api-key-value>' \
5   --header 'Content-Type: application/json' \
6   --data-raw '{
7   "payload": {
8     "property1": "string",
9     "property2": "string"
10   },
11   "points": [
12     0,
13     3,
14     10
15   ]
16 }'
17 
18 # Overwrite payload by filter
19 curl  -X PUT \
20   'http://localhost:6333/collections/collection_name/points/payload' \
21   --header 'api-key: <api-key-value>' \
22   --header 'Content-Type: application/json' \
23   --data-raw '{
24   "payload": {
25     "property1": "string",
26     "property2": "string"
27   },
28   "filter": {
29     "must": [
30       {
31         "key": "color",
32         "match": {
33           "value": "red"
34         }
35       }
36     ]
37   }
38 }'

200Updated

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": {
5     "status": "acknowledged",
6     "operation_id": 1000000
7   }
8 }

Delete payload

Up Next

Built with

1	# Overwrite payload by ID
2	curl -X PUT \
3	'http://localhost:6333/collections/collection_name/points/payload' \
4	--header 'api-key: <api-key-value>' \
5	--header 'Content-Type: application/json' \
6	--data-raw '{
7	"payload": {
8	"property1": "string",
9	"property2": "string"
10	},
11	"points": [
12	0,
13	3,
14	10
15	]
16	}'
17
18	# Overwrite payload by filter
19	curl -X PUT \
20	'http://localhost:6333/collections/collection_name/points/payload' \
21	--header 'api-key: <api-key-value>' \
22	--header 'Content-Type: application/json' \
23	--data-raw '{
24	"payload": {
25	"property1": "string",
26	"property2": "string"
27	},
28	"filter": {
29	"must": [
30	{
31	"key": "color",
32	"match": {
33	"value": "red"
34	}
35	}
36	]
37	}
38	}'

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"status": "acknowledged",
6	"operation_id": 1000000
7	}
8	}