---
title: "Bulk subscription action on a list of users"
method: PUT
path: "/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}"
tags: ["subscriptions"]
---

# Bulk subscription action on a list of users

`PUT /api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}`

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>.

## Path parameters

- `subscriptionGroup` string, required
- `subscriptionGroupId` integer, required

## Query parameters

- `action` string, required

## Request body

- BulkSubscriptionActionRequest
  - `users` string[] — Users to subscribe/unsubscribe, identified by <code>email</code>.
  - `usersByUserId` string[] — Users to subscribe/unsubscribe, identified by <code>userId</code>.

## Response `200`

successful operation

## Other responses

- `202` — Accepted a request for bulk subscription actions
- `400` — Invalid parameters
- `401` — Invalid API key
- `404` — Endpoint not found
- `409` — Email/userId conflict

---

[API](https://skmtc.net/iterable/apis/iterable-api.md) · [All operations](https://skmtc.net/iterable/apis/iterable-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/iterable/iterable-api/revisions/afaab604b58c/schema)