CLcleeng

Update switch

Changed on

Use this endpoint to manage a subscription switch.

Currently, this endpoint supports cancelling a pending switch. (Pending is the status of the switch between the subscription switch request and the actual switch processing.)

Cancelling a pending switch triggers a subscriptionSwitchCancelled webhook.

patch/subscription_switches/{switchId}

Request

  • Base URL
    https://mediastoreapi-sandbox.cleeng.com
  • URL
    https://mediastoreapi-sandbox.cleeng.com/subscription_switches/{switchId}
  • Auth
    API key in header Authorization

Path parameters

switchIdstring required

Cleeng ID of a switch

Request body

statusstring required

The status of the updated switch. Supported status: cancelled.

Response

200

Changes

  • b4b65aa4f14cRevision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id 31-update-switch removed and replaced with update-switch

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status