Update an existing CommPeak integration to the new API names, base URLs, and credentials.
If you built an integration with CommPeak APIs before October 2026, check three things: the API names, the base URLs, and the credentials. Most requests now go through one address, https://api.commpeak.com. The PBX Stats API is deprecated and is not served through api.commpeak.com.
API names
| Previous name | Current name |
|---|---|
| CommPeak Billing API | Portal API |
| Cloud PBX API | PBX API |
| LookUp API | Lookup API |
| TextPeak API | TextPeak API and TextPeak Streams API |
| Dialer API | Dialer API (no change) |
Base URLs
| API | Previous base URL | Current base URL |
|---|---|---|
| Portal API | https://api.commpeak.com | https://api.commpeak.com/portal |
| Dialer API | https://{subdomain}.td.commpeak.com/api | https://api.commpeak.com/dialer/{sub_domain}/api |
| PBX API | https://{subdomain}.td.commpeak.com/api | https://api.commpeak.com/pbx/{sub_domain}/api |
| Lookup API | https://lookup.commpeak.com | https://api.commpeak.com/lookup |
| TextPeak API | https://gw.commpeak.com/textpeak | https://api.commpeak.com/textpeak |
| TextPeak Streams API | https://gw.commpeak.com/textpeak | https://api.commpeak.com/textpeak/streams |
Credentials
The Dialer API and PBX API now use your Portal API key with Full access (all services) instead of an API user and password. To create or update the key, see Creating a Portal API key.
Dispatch Automation and Click2Call have their own authentication and still run on your subdomain, as described in Endpoints you call on your own subdomain. The Portal and TextPeak APIs use the same credentials as before. Two more changes affect existing integrations:
- Lookup API: legacy tokens from the Lookup API Service tab of the CommPeak Portal are deprecated. Switch to a Portal API key with Full access (all services).
- Portal API (previously the CommPeak Billing API): send the key as the raw
Authorizationheader value. If your integration sendsBearer <API_KEY>, remove theBearerprefix. The gateway tolerates it, but the raw key is the supported format.
Endpoint pages
Endpoint pages in this API Reference also have new addresses. For example, simplesend is now stream_simple_send, and customerdetails is now customer_details. Update any bookmarks or internal links that point to the previous pages.
Migrating your integration
Update the base URLs
Replace each base URL in your code or configuration with the current one from Base URLs.
Switch Dialer and PBX to an API key
For Dialer API and PBX API requests, create a Portal API key with Full access (all services) and send it in the Authorization header instead of your API user and password.
Test each API
Make a read-only test request for each API you use, for example the requests in Making your first request.
Check your request rate
The previous limit was 400 requests per minute per company domain and IP address. api.commpeak.com allows about 10 requests per second, so check your peak request rate and retry 429 responses with an increasing delay.
Check your subdomain endpoints
Check that Dispatch Automation and Click2Call requests still go to your own subdomain.
Update links and bookmarks
Update bookmarks and internal links that point to previous endpoint pages.
If a request fails after the change, see Troubleshooting your first request.