---
title: "Scoped named user batch operations"
method: POST
path: "/api/named_users/scoped/{named_user_id}"
tags: ["Named Users"]
---

# Scoped named user batch operations

`POST /api/named_users/scoped/{named_user_id}`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/named_users/scoped/{named_user_id}`
- Auth: one of:
  - HTTP basic
  - HTTP basic
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `http://oauth2.{domain}.com/token` scopes: `nu`
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/named_users/scoped/:named_user_id/post.ts> (a function with typed inputs; its response is checked against the schema)

Supports multiple operations on a named user within a single request for a specified `scope`. The supported operation is
`subscription_lists`. The behavior of each of these operations are the same as their individual request counterpart.

## Path parameters

- `named_user_id` string, required

## Request body

- object
  - `scoped` ScopedBatchItem[]: An array of scopes and subscription lists.
    - `scope` Scopes[], required
    - `subscription_lists` NamedUserSubscriptionListsObject, required: Defines the subscription list changes.
      - `subscribe` string[]: Subscribe to the specified subscription list identifier.
      - `unsubscribe` string[]: Unsubscribe the specified subscription list identifier.

## Response `200`

The scoped named user batch operations succeeded.

- OkResponseObject: Returned with 2xx Responses. At a minimum, successful calls return `true` for the `ok` key. If your call includes a verbose response (as with `GET` requests, etc.), the `ok` key will appear in the top-most object, outside the verbose response.
  - `ok` boolean, required: Success.
  - `operation_id` string, uuid: A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple `push_id` strings, but a single `operation_id`) or operations that change an existing resource.

## Other responses

- `400`: There was a parsing or validation error in the request. Bad Request errors typically include `path` and `location` in the response to help you find the cause of the error.
- `401`: Authentication information (the app key and secret or bearer token) was either incorrect or missing.
- `403`: Authentication was correct, but the user does not have permission to access the requested API, e.g., if the feature in question is not included in your pricing plan.
- `406`: Return when the client requests a version of the API that cannot be satisfied, because no compatible version is currently deployed.

## Changes

- **2022-03-24** `ca569bd1394d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/airship/apis/airship-api/changes/api/named_users/scoped/:named_user_id/post.md)

---

[API](https://skmtc.dev/airship/apis/airship-api.md) - [All operations](https://skmtc.dev/airship/apis/airship-api/llms.txt) - [OpenAPI document](https://skmtc.dev/airship/apis/airship-api/revisions/bd6ab947117a?raw)