latestSwagger 2.02026-08-10148196271.0 KB
afaab604b58c
subscriptions
Bulk subscription action on a list of users
Subscribes or unsubscribes multiple users to the specified subscription group. In <code>users</code>, list <code>email</code> addresses. In <code>usersByUserId</code>, list <code>userId</code> values. A single request can include both <code>users</code> and <code>usersByUserId</code>. To enable this API, contact your customer success manager.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.
put/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}
Path parameters
subscriptionGroupstring required
Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]
subscriptionGroupIdinteger required
Subscription Group Id [Numeric]
Query parameters
actionstring required
subscribe or unsubscribe
Request body
Response
successful operation