> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Transfer Subscription

> Transfer a Subscription to a different user within the same OneSignal app. Useful for associating existing Subscriptions like push, email, or SMS with a new or updated user identity.

## Overview

Use this API to transfer a Subscription from one user to another within the same OneSignal app.

It is highly recommended to use our web and mobile SDKs to set and update the External ID with the `login` method instead of this API. Your app or website may continue to be setting the wrong External ID. Make sure to only use this API if you are setting the same External ID within your app or website.

This is typically used when:

* You want to reassign an existing push, email, or SMS Subscription to a new or updated user.
* You have changed how you're identifying users (e.g., migrating from anonymous to known users).

<Note>
  - Subscriptions **cannot be transferred across different OneSignal apps**.
  - For email and SMS Subscriptions, you can instead create new ones using [Create User](/reference/create-user).
  - For push Subscriptions, platform limitations may apply—see [Subscriptions](/docs/en/subscriptions#importing-push-subscriptions) for details.
</Note>

***

## How to Use This API

### Required Path Parameter: `subscription_id`

You must know the `subscription_id` of the subscription to be transferred. This is a unique UUID assigned by OneSignal.

### Required Body Parameter: `identity` (object)

This specifies the user the subscription should be moved to. Only **one alias** should be used per request. You can identify the target user using one of:

* `external_id` (recommended)
* `onesignal_id`
* A [custom alias](/docs/en/aliases)

***


## OpenAPI

````yaml PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner
openapi: 3.1.0
info:
  title: api.onesignal.com
  version: '11.6'
servers:
  - url: https://api.onesignal.com
security:
  - {}
paths:
  /apps/{app_id}/subscriptions/{subscription_id}/owner:
    patch:
      summary: Transfer subscription
      description: >-
        Transfer a Subscription to a different user within the same OneSignal
        app. Useful for associating existing Subscriptions like push, email, or
        SMS with a new or updated user identity.
      operationId: transfer-subscription
      parameters:
        - name: app_id
          in: path
          description: >-
            Your OneSignal App ID in UUID v4 format. See [Keys &
            IDs](/docs/en/keys-and-ids).
          schema:
            type: string
          required: true
        - name: subscription_id
          in: path
          description: >-
            The unique Subscription ID in UUID v4 format to transfer to the new
            user.
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identity:
                  type: object
                  description: >-
                    Identifies the user that this subscription is moved to. Must
                    contain exactly one alias.
                  properties:
                    external_id:
                      type: string
                      description: >-
                        The main user ID to identify the user. See
                        [Users](/docs/users).
                      default: test_external_id
                    onesignal_id:
                      type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    identity:
                      external_id: the-external-id-transferred-to
                      onesignal_id: the-onesignal-id-transferred-to
              schema:
                type: object
                properties:
                  identity:
                    type: object
                    properties:
                      external_id:
                        type: string
                        example: the-external-id-transferred-to
                      onesignal_id:
                        type: string
                        example: the-onesignal-id-transferred-to
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicErrorResponse'
              example:
                errors:
                  - Details about the error.
        '403':
          description: '403'
          content:
            application/json:
              examples:
                Result:
                  value:
                    errors:
                      - Forbidden
              schema:
                $ref: '#/components/schemas/BasicErrorResponse'
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value:
                    errors:
                      - code: subscription-0
                        title: Subscription not found
              schema:
                $ref: '#/components/schemas/StructuredErrorResponse'
        '429':
          description: '429'
          content:
            application/json:
              examples:
                Result:
                  value:
                    errors:
                      - code: Rate Limit Exceeded
                        title: Example error title
                        meta: {}
              schema:
                $ref: '#/components/schemas/StructuredErrorResponse'
          headers:
            Retry-After:
              description: >-
                Number of seconds to wait before retrying the request. Always
                emitted on 429 responses.
              schema:
                type: integer
                minimum: 0
        '503':
          description: >-
            Service temporarily unavailable. Retry after a short backoff. The
            body may be empty or non-JSON in some failure modes.
          headers:
            Retry-After:
              description: >-
                Number of seconds to wait before retrying. Optional — may be
                absent when the response is generated upstream.
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicErrorResponse'
              example:
                errors:
                  - Service temporarily unavailable
      deprecated: false
components:
  schemas:
    BasicErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
          description: One or more human-readable error messages.
        success:
          type: boolean
          description: >-
            Present (and `false`) on some endpoints (notifications, templates,
            segments). Not emitted by every endpoint.
        reference:
          type: array
          items:
            type: string
          description: >-
            Documentation URL fragments related to the error. Only emitted by
            the API-key auth error helpers.
    StructuredErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/StructuredErrorItem'
    StructuredErrorItem:
      type: object
      required:
        - code
        - title
      properties:
        code:
          type: string
          description: >-
            Stable error-code identifier. Use this for programmatic branching in
            your integration.
        title:
          type: string
          description: >-
            Human-readable error message intended for logs and operator-facing
            surfaces.
        meta:
          type: object
          additionalProperties: true
          description: >-
            Optional structured details about this specific error. The shape of
            `meta` varies by `code` — for example, the create-user `Conflict`
            code returns `{ conflicting_aliases: { [alias_label]: alias_id } }`.

````