Upcoming Release

Toggle Migration Mode for a product

PUT /products/{product_id}/migration_mode
O auth2

Safely migrate accounts and line items from another system into Canopy for accounts enrolled in this product while Migration Mode is on.

application/json

Body

Update admin panel for a product.

  • migration_mode boolean

    If migration mode is on, Canopy will not autogenerate statements for this account.

    Default value is false.

Responses

  • 200 application/json

    Migration Mode updated successfully

    Hide response attribute Show response attribute object
    • description string Required
  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

PUT /products/{product_id}/migration_mode 
curl \
 --request PUT 'https://sandbox-api.canopyservicing.com/products/{product_id}/migration_mode' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"migration_mode":true}'
Request examples 
{
  "migration_mode": true
}
Response examples (200) 
{
  "description": "string"
}