Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

Transfer subscriptions

Transfers up to 20 subscriptions from a source account to a target account within the same siteId.

  • sourceAccountId and targetAccountId (if provided) must reference the same siteId.
  • A maximum of 20 subscriptions can be transferred per request.

In the “Try It!” panel, open the EXAMPLES dropdown to select a request example:

Request exampleWhen to use it
New Account TransferCreate a new target account and transfer subscriptions in one call.
Existing Account TransferTransfer subscriptions to an existing target account.
post/subscriptions/transfer

Request body

initiatedBystring required

Email address of the user initiating the transfer.

sourceAccountIdstring required

Identifier of the account that currently owns the subscriptions to transfer.

subscriptionsstring[] required

List of subscription IDs to be transferred.

Example request

{
  "initiatedBy": "first.last@domain.com",
  "sourceAccountId": "aAB0cdefGHiJkL0m8n8OpQ",
  "targetAccount": {
    "email": "first.last@domain.com",
    "account": {
      "firstName": "First",
      "lastName": "Last",
      "company": "Company Name",
      "phone": "555-555-5555",
      "language": "en",
      "address": {
        "line1": "123 Main Street",
        "city": "Santa Barbara",
        "region": "US-CA",
        "country": "US",
        "postalCode": "93101"
      }
    }
  }
}

Response

OK

statusstring

HTTP status code indicating the result of the transfer operation.

siteIdstring

Unique identifier of the site where the subscriptions reside.

sourceAccountIdstring

Unique identifier of the account from which subscriptions were transferred.

targetAccountIdstring

Unique identifier of the account to which subscriptions were transferred.

transferredSubscriptionsstring[]

List of subscription IDs that were successfully transferred.

remainingSubscriptionsstring[]

List of subscription IDs still associated with the source account after the transfer.

Example response

{
  "status": "200",
  "siteId": "aBCDE12fGH",
  "sourceAccountId": "abCdE1FGH2Hij3KLMnOpqR",
  "targetAccountId": "rST2uv1wXy279zABCd_E2f",
  "transferredSubscriptions": [
    "1abc2DE_FGhIjKLm3NoPQR"
  ],
  "failedSubscriptions": [
    {
      "subscriptionId": "12cDfgHIjKLmNOPqRs_tUV",
      "errorMessage": "Subscription not found",
      "errorCode": "SUBSCRIPTION_NOT_FOUND"
    }
  ],
  "remainingSubscriptions": [
    "a12cD2-eFGhIjKLXn4OPqR"
  ]
}