Add or remove Synoptic stream targets
patch_stream_custom_targetsAdd or remove targets in the signed-in user’s selection on a Synoptic custom-target stream, keeping other targets, and return the resulting list. Targets, such as accounts, channels, repositories, or keywords in the format get_stream describes, choose which of the stream’s posts the user receives. Posts for removed targets stop appearing in the user’s stream reads, post searches, and WebSocket API delivery, and in open Synoptic app feeds after they reconnect. Removed targets are then also removed from the user’s collection sources limited to specific targets, and such a source left with no targets is deleted. The stream’s owner receives all followers’ targets and may use them to decide what to collect. Requires following the stream and an active direct subscription; every resulting target, including existing ones, must match the stream’s target format, and the list must fit the subscription’s target allowance. Does not purchase access or confirm that targets are collected.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| add | No | Target values to add in the stream’s required format. Existing values are retained. A value in both add and remove remains selected. | |
| remove | No | Saved target values to remove. At least one of add or remove must contain a value. | |
| streamId | Yes | ID of an existing custom-target stream. Use get_stream to read its target-format instructions. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| customTargets | Yes |