Select your Platform:
Batch Methods
Confused about "Batch Methods"?
Let us know how we can improve our documentation:
Batch Add Activities
Copied!Confused about "Batch Add Activities"?
Let us know how we can improve our documentation:
Multiple activities can be added with a single batch operation. This is very convenient when importing data to Stream.
Parameters
Copied!Confused about "Parameters"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| activities | list | The list of activities to be added (as specified in Adding Activities) | - | ✓ |
Activity IDs
Copied!Confused about "Activity IDs"?
Let us know how we can improve our documentation:
The API will return a response with a list containing the activity ids.
Batch Activity Add
Copied!Confused about "Batch Activity Add"?
Let us know how we can improve our documentation:
This method allows you to add a single activity to multiple feeds with one API request.
TO field targeting is not permitted via this endpoint. Attempting to add activities with a 'to' property will result in an error response.Parameters
Copied!Confused about "Parameters"?
Let us know how we can improve our documentation:
name | type | description |
|---|---|---|
feeds | list | The list of a feeds e.g. |
activity | object | The activity object (see Feed endpoint for reference) |
Batch get Activities by ID
Copied!Confused about "Batch get Activities by ID"?
Let us know how we can improve our documentation:
Activities can be retrieved by IDs or foreign ID and time.
Parameters
Copied!Confused about "Parameters"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| ids | string | The comma-separated list of activity IDs to retrieve | - | ✓ |
| foreign_id_times | list | The list of foreign_id and time values used to retrieve activities | - | ✓ |
reactions.own | boolean | Include reactions added by current user to all activities | - | ✓ |
reactions.recent | boolean | Include recent reactions to activities | - | ✓ |
reaction.counts | boolean | Include reaction counts to activities | - | ✓ |
Batch Follow
Copied!Confused about "Batch Follow"?
Let us know how we can improve our documentation:
Stream's Follow Many functionality gives you a fast method to follow many feeds in one go. This is convenient when importing data or on-boarding new users.
Follow Many has a limit of 2,500 follows per request.
activity_copy_limit can be specified to copy specific number of activities. By default, it's 100 such that upon follow 100 activities from the followed feed will be seen in our feed.
Parameters
Batch Unfollow
Copied!Confused about "Batch Unfollow"?
Let us know how we can improve our documentation:
Unfollow Many enables you to unfollow many feeds in bulk. However, its implementation is heavy. That's why its usage restricted to Enterprise accounts. While unfollowing, history can be kept by keep_history. It's false by default. When unfollow is done, any activities that come from unfollowed feed will be removed but if the flag is set, then this history will remain.
Unfollow Many has a limit of 250 unfollows per request.
Batch update TO targets
Copied!Confused about "Batch update TO targets"?
Let us know how we can improve our documentation:
Allows you to update the TO targets of multiple activities in a feed at once, up to a max of 100 activities per call.
