add_suprsend_object_subscriptions
Subscribe users or objects to a specific object. Pass recipients as a mix of user distinct_ids and object identifiers.
Instructions
Subscribe one or more users or other objects TO this object. The recipient list can mix users and objects in a single call.
Recipients: users by distinct_id, objects by object_type + id. Each entry's shape follows the SuprSend recipient format. Optional properties attach metadata to each subscription (role, joined_at, etc.).
When NOT to use:
To remove subscribers — there is no remove tool; use the SuprSend API directly.
For mailing-list / segment membership — those are managed via the Lists API.
For preference changes on existing subscribers — use the per-user / per-object preference tools.
Side effects: each successful subscription is a separate row. Calling this twice with the same recipient creates duplicate-looking entries; check existing state with get_suprsend_object_subscriptions first if duplicates would be a problem.
Returns: the created subscription records on success.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| object_id | Yes | The object_id of the object's subscriptions to get. | |
| workspace | No | Suprsend workspace to get the object from. | |
| properties | No | Properties of an user/object | |
| recipients | Yes | Users & Objects who are subscribing to an object | |
| object_type | Yes | The type of object you want to get. |