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 create client docid\ b92lq wh s j0b2f pz35 post post /v2/clients/create update client docid\ hxfez4r8wpsjxmbykfyg post post /v2/clients/update/\ id retrieve client docid 4o iaz ixsis6pevoyrsg get get /v2/clients/retrieve/\ id delete client docid 5czjqu5jzm3 koo62eyde delete delete /v2/clients/\ id bulk delete docid\ gb5ti8mvjw8ogsr7skkr6 post post /v2/clients/bulk/delete make live docid zict1ro iwxjptzed5h3 post post /v2/clients/make live/\ id list clients docid\ ztoaawc6yntt9cjfanxxp get get /v2/clients/list offer trial docid\ ag5b6jpkkjppgvlzywbbk post 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 client events (whitelabel) docid\ v hdafu6clw5cmpxckyss 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