Partner Management API Integration

Partner Management API Integration

The Partner Management portal supports operation via both the UI and underlying API. For those partners that already have their own partner and product management system you may prefer to integrate via API to avoid introducting a new portal. Often partners start with the UI whilst getting up to speed on the process and products before migrating to a deeper integration.

To configure API access:
  1. Login to admin.yourbrand.com
  2. Naviage to Settings on the left side navigation
  3. Click 'Create API Key'
    1. Whilst only a 'Name' is required for the key, we strongly recommend setting the notifcation email such that future API changes (e.g. breaking changes to existing API contracts) are notified to you well in advance of any changes.
The same page includes a link to the API specification and documentation. Reach out to your account manager for further help on API integration and best practices.

    • Related Articles

    • Partner Hierarchy

      Partner Hierarchy Overview The Partner Management portal allows full flexibility in how your Partner tree is built. This is to allow you to match the hierarchy with your own business. At a high level there are three fundamental object types: Partners ...

    • Access a Customer's Call Manager as a Partner

      Partners can access the Call Manager instances for all their customers, both at their Partner level and for all child Partners. Login to admin.yourbrand.com Partner Management portal. Navigate to the appropriate Partner level Select Customers on the ...

    • Adding Resellers (Child Partners)

      The Partner Management Portal allows a deep tree of partners. A typical setup is to replicate your business's reseller tree in this portal. Add Reseller / Child Partner Adding a new child partner/reseller is a simple process: Login to ...

    • What's new in Provisioner

      November 2025 Customer Tenant Usage Reporting The Provisioner UI now allows customer reporting to be viewed from the UI. This is available via the Customer Service instance list, then select 'Status' to see a table of available report data covering ...

    • Adding A Customer and Service

      Customers can be onboarded via the Partner Management Portal. Adding A Customer Once logged in, selected Customers from the left side menu, then 'Add Customer' button on the right. You will see the new Customer form: The customer name and reference ...