WhiteLabel API

Clients

The Clients API delivers comprehensive access to endpoints, enabling the creation, management, deletion, and retrieval of clients within your Whitelabel platform. This set of functionalities forms a robust foundation for maintaining a well-organized, efficient, and adaptable client management system, ultimately serving to enhance the operational productivity of your platform.

Importantly, clients can exist in two states, demo or live. The demo state offers a trial experience of the platform, serving as an effective tool for client acquisition and engagement. The live state represents the full, paid (or free) use of your platform. A distinguishing feature is that you can convert demo clients to live at any point, offering considerable flexibility in managing client lifecycle and platform monetization strategies.

To maintain control and security, Tamio enables you to suspend or unsuspend client accounts from your Whitelabel platform as necessary. This function is particularly beneficial in managing non-compliant clients or addressing payment irregularities, while also offering the ability to reinstate client access when appropriate.

Moreover, you to set granular permissions on each client. This feature allows you to specify and control client access to different platform resources, which can enhance security, improve user experience, and support role-based access control strategies.

Finally, the capability to set custom quotas on each client further enriches the platform’s adaptability; whether to manage resource allocation, control costs, or manage performance.

API Endpoints

Description

Method

URL

POST

/v2/clients/create

POST

/v2/clients/update/:id

GET

/v2/clients/retrieve/:id

DELETE

/v2/clients/:id

POST

/v2/clients/bulk/delete

Make Live

POST

/v2/clients/make-live/:id

GET

/v2/clients/list

Offer Trial

POST

/v2/clients/offer-trial/:id

Webhook Events

There are three webhook notification events associated with the Clients API.

  • client-created
  • client-updated
  • client-removed

You can see examples of notification events here:

Permissions

Whether managing teammates or creating API developer keys, you can customise permissions when accessing Client API resources. The default permissions are view, edit, create and remove.