Updates to CallRail's API

On August 19th, CallRail will be disabling our API v2, and API v3 will be the only available version of our API. Please take the steps below to ensure that any API usage with CallRail is uninterrupted on the date that the previous version is deprecated.

The CallRail API v3 is very similar to v2 except for one major difference: in API v3, our resource primary_key ids are now alpha-numeric strings instead of all-numeric strings. The alpha-numeric id will be formatted with a 3 letter prefix in reference to the resource followed by a 35 character alphanumeric identifier. 

For example, for the Call Resource, an ID for a Call would look like "CALb14811eb573645c6989000cf426b9772".

A new API key will not be necessary. Existing API v2 keys will work with v3.

Updating to API v3

  1. Update your code to access all API endpoints at api.callrail.com/v3.
  2. Ensure you're using our latest 35-character alphanumeric identifiers.
  3. Backfill your data as necessary using the instructions below.

Additional information

If you are storing using the “id” fields, you’ll need to ensure your database will handle IDs as a string rather than an integer. 

Additionally, you can use API v3 to backfill your historical data and get the IDs in the updated format for any stored record.

Our API v3 accepts the old-format numeric "masked" IDs on a request, and returns the newer-formatted alpha-numeric "resource" IDs in the response. For example, this request:


/v3/a/{account_id}/calls/{call_masked_id like 123456789}.json

Would include the new "resource" ID in the response:

"id": "CAL8154748ae6bd4e278a7cddd38a662f4f"

This can be done for each object (Calls, Forms, Texts) requiring a backfill.


Was this article helpful?
0 out of 0 found this helpful

Articles in this section

Ask the Community
Find best practices, post, and learn from CallRail users.
CallRail Support Hours
Weekdays 9:00am - 9:00pm EST & Lead Center Support available Saturday 9:00am - 6:00pm EST