Batch Endpoints

Java

Select your Platform:

backend SDKs

client SDKs

You can use batch endpoints to insert, delete or read multiple entries at once. These three endpoints are only available when running Stream on your backend.

Upsert

Confused about "Upsert"?

Let us know how we can improve our documentation:

Upsert allows you to insert or update up to 1000 entries with a single API call. The payload is an array of entries. Entries that already exist (same ID) will be updated with the new version.

name	type	description	default	optional
collection	string	The name of the collection	-
entry_id	string	The id of the entry, if not given an ID will be generated by Stream	-	✓
data	object	The data related to the user	-

Select

Confused about "Select"?

Let us know how we can improve our documentation:

This method allows you to retrieve up to 1000 entries by ID.

name	type	description	default	optional
foreign_ids	list of string	The list of collection:id entries to retrieve (eg. ["visitor:123", "visitor:124"])	-	✓
data	object	The data related to the user	-

Delete Many

Confused about "Delete Many"?

Let us know how we can improve our documentation:

This method allows you to delete up to 1000 entries by ID.

name	type	description	default	optional
collection	string	The name of the collection	-
ids	list of strings	The list of id to remove	-	✓

When you delete an entry from a collection any references will be converted to a missing reference error when reading feeds with enrichment.

Select your Platform:

backend SDKs

client SDKs

Confused about "Batch Endpoints"?

Upsert

Confused about "Upsert"?

Select

Confused about "Select"?

Delete Many

Confused about "Delete Many"?

Batch Endpoints Feedback