Getting Started

Welcome to CallRail API v3

Welcome to the documentation for v3 of the CallRail API.

CallRail helps data-driven marketers measure the performance of their campaigns by providing multi-channel call attribution. These call analytics give users the insight they need to optimize their advertising campaigns, increase sales effectiveness, and improve customer retention.

The CallRail REST API provides a method to programmatically access and modify the data within your CallRail account. It is intended for developers and customers looking to integrate custom software directly with CallRail. Getting started is simple, and with this guide you can make your first API request in a matter of minutes!

Terminology

CallRail has its own nomenclature that is used to describe our call tracking technology. This section is a brief glossary of terms that are useful in understanding our platform. For a more thorough overview of CallRail, check out the articles in the Getting Started section of our support site.

Dynamic Number Insertion (DNI) - CallRail can dynamically change the telephone number your website visitors see based on how they came to the site. When a visitor navigates to your website through one of the sources you’re tracking, CallRail’s JavaScript will detect the phone numbers on your web page and swap them with the correct tracking number. We’ll then store the visitor’s source in a cookie so they’ll continue to see the same tracking number each time they return to your website (unless our JavaScript is removed).

Source Tracker - Source trackers associate a single tracking number to a certain set of your customers based on how they found the number. For example, a single source tracker might be used to identify website visitors who came from facebook.com, who found your site from a paid Google search, or via an offline source such as a billboard or TV advertisement.

Keyword (Session) Tracker - Session trackers serve one number from a pool of tracking numbers to website visitors, allowing you to associate calls to individual visitors. You can also see the keywords they searched for before arriving via search engine, as well as their browsing history on your site.

Destination Number - The destination number is where the phone will ring when customers dial your tracking number. This is typically your primary business phone number.

Tracker - This is a generic term applied to any source tracker or keyword pool.

Swap Target - The swap target is the telephone number CallRail looks for on your website to dynamically replace with a tracking number. By default, the swap target is the destination number, but you can specify a different swap target for each tracker on the number configuration page.

Source Type - The online or offline source the tracking number(s) is configured to track. Our company-specific dynamic number insertion script displays tracking numbers based on the source type of the tracker in question.

Authorization

CallRail uses API keys to authenticate and authorize requests being made to the API. These API keys are scoped to individual users, and have access to the same data as the user who created the key. API responses will only include data pertaining to the user’s API key. For example, a request to retrieve a list of tracked phone calls will only return calls the user could see in CallRail’s interface. Calls placed to accounts or companies where the user has no access will not be returned. Similarly, anyone who has your API key can use that key to access or modify any data you have control over.

The CallRail API authenticates via the HTTP Authorization header: Authorization: Token token="YOUR_API_KEY". All requests to all API endpoints require an API key to be provided.

Conventions

The CallRail API adheres to REST architectural principles. REST (Representational State Transfer) takes advantage of HTTP methods to create, read, update, and delete (CRUD) resources on cloud applications like CallRail.

The CallRail API sends and receives data in JSON format. JSON (JavaScript Object Notation) is completely language independent and uses human-readable text to send data objects consisting of key-value pairs.

Supported HTTP Methods

Each API endpoint in this guide is documented with the correct HTTP method, endpoint URL, end-point specific request parameters, and sample requests and responses. Additional tables that describe the response in detail are also provided.

Additional Resources

• More information on HTTP.

• More information on REST.

• More information on JSON.

Offset Pagination

A paginated JSON response using offset pagination will include these fields in the response metadata:

{
  "page": 3,
  "per_page": 25,
  "total_pages": 5,
  "total_records": 111
}

All requests to the CallRail API that return more than one object will be paginated. For requests to the Listing All Calls endpoint, we recommend using Relative Pagination. For all other endpoints, you can paginate through results with the following attributes:

Pagination Parameters

Example Queries That Include Pagination Parameters

Specifying a Page:

• GET /v3/a/{account_id}/users.json?page=3

This request will return page 3 from the Users index endpoint.

Specifying the Number of Records Per Page:

• GET /v3/a/{account_id}/users.json?per_page=25

This request will return 25 objects per page from the Users index endpoint.

Paginated Response Fields

The fields listed below will be included in the paginated JSON response for endpoints that return a collection of objects.

Relative Pagination

A paginated JSON response using relative pagination will include these fields in the response metadata:

{
  "next_page": "https://api.callrail.com/v3/a/227799611/calls?action=index&agency_id=227799611&api_sort%5B%5D%5Bstart_time%5D=desc&api_sort%5B%5D=start_time&controller=api%2Fv3%2Fcalls&format=json&no_one_to_many_associations=true&offset=1&page=1&per_page=100&relative_pagination=true",
  "has_next_page": true
}

All requests to the CallRail API that return more than one object will be paginated. When calling the Listing All Calls endpoint for larger data sets, we recommend the use of relative pagination for better performance. Relative pagination separates the results of your query across multiple pages, without explicitly defining the number of pages in the response or numbering individual pages. Instead, relative pagination provides the endpoint to query the next page of results, and a has_next_page parameter to indicate when you’ve reached the final page of results for your query.

Note that with relative pagination, there is a small possibility that page n+1 might not start exactly at the end of page n, if a new call occurs before page n+1 is fetched.

You should not attempt to use a mix of relative and offset pagination across requests for the same dataset. Use a consistent pagination method to fetch all results for your query.

You can use relative pagination by specifying the following attributes:

Relative Pagination Parameters

Note that Relative Pagination is currently only supported on the Listing All Calls endpoint. All other endpoints must use Offset Pagination.

Relative Pagination Metadata

Example Queries That Include Pagination Parameters

Specifying a Page:

• GET /v3/a/{account_id}/calls.json?relative_pagination=true&offset=4

This request will return page 5 from the Calls index endpoint.

Specifying the Number of Records Per Page:

• GET /v3/a/{account_id}/calls.json?relative_pagination=true&per_page=25

This request will return 25 objects per page from the Calls index endpoint.

Sorting

A sorted JSON response might look like this:

{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 3,
  "users": [
    {
      "email": "bob@example.com",
      "id": 223166018,
      "created_at": "2016-01-29T12:43:10.286-05:00",
      "role": "admin",
      "first_name": "Bob",
      "last_name": "Belcher",
      "name": "Bob Belcher"
    },
    {
      "email": "linda@example.com",
      "id": 159539165,
      "created_at": "2016-04-08T10:55:38.632-04:00",
      "role": "manager",
      "first_name": "Linda",
      "last_name": "Belcher",
      "name": "Linda Belcher"
    },
    {
      "email": "teddy@example.com",
      "id": 330833311,
      "created_at": "2015-03-03T12:15:22.954-05:00",
      "role": "reporting",
      "first_name": "Teddy",
      "last_name": "Francisco",
      "name": "Teddy Francisco"
    }
  ]
}

Most endpoints that return a list of objects also support sorting. Depending on the endpoint, you will find various fields enabled for sorting. Sorting is always either alphabetical, or reverse chronological (newest first).

Example Query That Includes The Sorting Parameter

Sorting the Results: Users Index Endpoint

• GET /v3/a/{account_id}/users.json?sort=email

Will return a list of user objects for the target account, sorted by email address in alphabetical order.

Ordering: Users Index Endpoint

• GET /v3/a/{account_id}/users.json?sort=email&order=desc

Will return a list of user objects for the target account, sorted by email address in reverse alphabetical order.

Field Selection

A JSON response which returns user-selected fields might look like this:

{
    "answered": false,
    "business_phone_number": null,
    "customer_city": "Seattle",
    "customer_country": "US",
    "customer_name": "Jovani Osinski",
    "customer_phone_number": "+15896836609",
    "customer_state": "WA",
    "direction": "inbound",
    "duration": null,
    "id": 444941612,
    "recording": "http://cdn.callrail.com/v3/a/297251749/calls/444941612/recording",
    "recording_duration": null,
    "start_time": "2017-06-04T13:36:24.000Z",
    "tracking_phone_number": "+14045555466",
    "voicemail": true,
    "company_id": "COM37221d54e80c4216898d2f857fc69fa0",
    "company_name": "Grand Symphony Resort"
}

Field selection allows for control of the fields included in a response. Field selection is available for endpoints that return a list of objects and endpoints that return a single object. Depending on the endpoint, additional fields can be included with the default response fields. Each endpoint will describe the possible fields for selection.

Example Query That Includes Additional User Requested Fields

Selecting Specific Fields: Calls Show Endpoint

• GET /v3/a/{account_id}/calls/444941612.json?fields=company_id,company_name

Will return the additional user requested fields for the target call.

Filtering

{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 1,
  "companies": [
    {
      "id": 196207137,
      "name": "Bob's Burgers",
      "status": "disabled",
      "created_at": "2016-02-23T20:16:38.389Z",
      "disabled_at": "2016-04-13T15:35:29.040Z"
    },
    {
      "id": 635837866,
      "name": "Falafel on a Waffle",
      "status": "disabled",
      "created_at": "2017-02-13T15:10:42.742Z",
      "disabled_at": "2017-02-13T15:39:23.149Z"
    },
    {
      "id": 289003184,
      "name": "Jimmy Pesto's Pizzeria",
      "status": "disabled",
      "created_at": "2015-11-24T17:51:34.908Z",
      "disabled_at": "2015-11-24T17:51:55.133Z"
    }
  ]
}

Filtering allows the list of objects returned for a specific endpoint to be filtered by specific parameters. Filtering is available for many endpoints that return a list of objects. Each endpoint that supports filtering will describe the possible filters.

Example Query That Includes The Filtering Parameter

Filter the Response: Companies Index Endpoint

• GET /v3/a/{account_id}/companies.json?status=disabled

Will return a list of company objects in the target account, where the companies are disabled companies.

Filtering Data by Date

Please note that according to our Data Retention Policy, Communication Records (which include phone calls, call recordings, text messages, chat logs, form submissions, web visitor sessions, and other types of data) are retained for 25 months, after which they are automatically deleted.

If you make a request to an endpoint for Communication Records that are outside of the retention period, you will receive an error directing you to revise your date range. This includes requests using the all_time date parameter.

The CallRail API accepts date filters in one of two formats: either a standardized date range, or specific start and end dates. In addition, a time zone can be specified to align dates as expected. The following endpoints accept these parameters:

• Listing All Calls
• Call Data Summary
• Listing All Conversations

Filtering by Standard Date Range

To choose a standardized date range (such as those seen in the CallRail UI), provide a date_range parameter. This is the default for API requests that don’t specify date parameters. Date interpretation according to the table below will be done according to the specified or default time zone.

ex. date_range=recent

*recent is the default view in the CallRail UI, and is the API default when no other date range parameters are specified.

Filtering by Specific Dates

To select data from a specific date range, provide the start_date and end_date parameters with the request. These parameters should be formatted according to ISO 8601. (ex. “2016-10-17”) Specific times of day are also acceptable in ISO 8601 format. (ex. “2015-09-05T14:00”)

Dates and times provided in this manner are inclusive. For example, listing all calls with start_date=2016-10-17 will be interpreted as beginning at midnight on that date, so all calls that occurred on that date will be included. Specifying end_date=2016-10-17 will be interpreted as calls up to 11:59:59pm on that date. To obtain all calls on a specific date, specify the same date for both start_date and end_date.

Date interpretation will be done according to the specified or default time zone.

ex. start_date=2016-10-01&end_date=2016-10-17

Searching

A JSON response based on a user-specified search term might look like this:

{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 2,
  "users": [
    {
      "email": "bob@example.com",
      "id": 223166018,
      "created_at": "2016-01-29T12:43:10.286-05:00",
      "role": "admin",
      "first_name": "Bob",
      "last_name": "Belcher",
      "name": "Bob Belcher"
    },
    {
      "email": "linda@example.com",
      "id": 159539165,
      "created_at": "2016-04-08T10:55:38.632-04:00",
      "role": "manager",
      "first_name": "Linda",
      "last_name": "Belcher",
      "name": "Linda Belcher"
    }
  ]
}

Searching is available for many collection endpoints that return a list of objects. Depending on the endpoint, various parameters will be enabled for searching.

Example Query That Searches The Endpoint

Searching for Records: Users Index Endpoint

• GET /v3/a/{account_id}/users.json?search=belcher

Will return a list of user objects in the target account that match the name given.

Time Zones

The CallRail API aligns all dates to the time zone specified within the account. This can be overridden for specified API requests by including a time_zone parameter. This parameter accepts any standard time zone from the list of common names below.

ex. time_zone=America/New_York

HTTP Response Codes

The CallRail API returns standard HTTP success or error status codes. For errors, extra information about what went wrong will be encoded in the response as JSON.

The various HTTP status codes that may be returned are listed below.

Rate Limiting

CallRail limits the number of requests to the API made by an account on an hourly and daily basis.

The default rate limits are described below. If you expect that your application will require more requests, please contact our support team.

If your application exceeds the rate limit, all endpoints will return the HTTP 429 response code. Applications should detect this code and react by pausing or slowing requests until the 429 clears.

Default Rate Limits

Your First API Request

A simple way to learn the CallRail API is to make an API request with Postman, a powerful HTTP client to help easily test web services.

For a more detailed overview of Postman, see the Postman Documentation.

Configuring Postman to Make CallRail API Requests

1. Set the correct HTTP verb and URL endpoint

• For this example, set the request method to GET
• Enter the endpoint URL: https://api.callrail.com/v3/a/{account_id}/companies.json
• Replace {account_id} with your account ID. If you don’t know your account ID, you can find it in the CallRail web UI. Find the nine digit number following /a/ in the URL displayed in your browser when viewing the CallRail dashboard.

2. Set the Authorization header

• Click the Headers tab and add a header key for “Authorization”. In the value field, enter Token token="YouAuthTokenHere"
• Be sure to replace YourAuthTokenHere with your API key.

(Right click on image and select View Image/Open Image In New Tab to expand the image.)

3. Click “Send” to execute your API request.

A successful response will return something similar to the following image.

(Right click on image and select View Image/Open Image In New Tab to expand the image.)

Congratulations! You’ve made your first request against the CallRail API. The remaining sections provide documentation for the available endpoints of the API.

Changelog

January 30, 2020

We have made changes to the API to more closely mirror the data that is displayed in the activity logs and in our reports. For marketing attribution data like Source, Medium, Campaign, Referrer, and Landing Page data, this will represent the lead’s first touch milestone. gclid and fbclid fields will return the most value associated with the call, even if the first touch milestone is a source other than Google Ads or Facebook Ads.

May 24, 2022

The Updating a Call endpoint has been enhanced to allow for edits to Customer Name, and setting Spam status to “true” to mark a call as spam.

June 9, 2022

We have added support for updating form submission data via the Updating a Form Submission endpoint.

June 14, 2022

We have added a milestones object to the Listing All Calls and Retrieving a Single Call endpoints. It describes the attribution for each of the lead’s milestones.

September 20, 2022

We have added a timeline_url field to the Listing All Calls, Retrieving a Single Call, and Listing All Form Submissions endpoints. It contains a link to the lead’s timeline.

March 3, 2023

We have added support for Relative Pagination to the Listing All Calls endpoint. This improves performance when fetching larger data sets from that endpoint.

March 22, 2023

We have added last_touch milestone data to the milestones object in the Listing All Calls and Retrieving a Single Call endpoints.

April 5, 2023

We have added a milestones object to the Listing All Form Submissions endpoint. It describes the attribution for each of the lead’s milestones.

April 13, 2023

Please note that according to our Data Retention Policy, Communication Records (which include phone calls, call recordings, text messages, chat logs, form submissions, web visitor sessions, and other types of data) are retained for 25 months, after which they are automatically deleted.

If you make a request to an endpoint for Communication Records that are outside of the retention period, you will receive an error directing you to revise your date range. This includes requests using the all_time date parameter.

July 19, 2023

New texting compliance rules driven by mobile carriers will require every business sending text messages to register with The Campaign Registry via CallRail.

Learn more about registration and fees and find a link to the registration form on our Text Messaging Compliance Registration support document.

Register by July 31, 2023 to prevent service disruptions to outbound texting, replying to messages, or using automated text responses.

October 26, 2023

Please note that passwords can no longer be managed via the API, regardless of the user making the request. Passwords can only be reset or changed in the app UI. Please refer to our support articles for instructions on how to change or reset your password.

May 10, 2024

The swap_cookie_duration value in the Companies endpoints now supports a swap_cookie_duration_unit to allow more flexibility when specifying a custom cookie duration.

May 16, 2024

The Listing All Calls and Retrieving a Single Call endpoints now include the person_id field, when requested using field selection. person_id helps you identify a particular lead across all their tracked interactions.

May 31, 2024

The Listing All Users endpoint now includes the companies object. This will list all the companies the user is currently associated with.

August 27, 2024

The Listing All Calls and Retrieving a Single Call endpoints now include the sentiment field, when requested using field selection. sentiment gives you the overall sentiment of the call and is available to customers who are using Premium Conversation Intelligence. The Listing All Calls endpoint also now includes the transcription when requested using field selection, which is a transcribed copy of the the conversation or voicemail message. Phone call transcription requires a subscription to a Conversational Intelligence plan.

September 10, 2024

When sending text messages, you are required to identify who you are and use at least one approved keyword to inform the recipient they can end communication at any time. The first time you text a lead (including when using the Send a Text Message endpoint), we will automatically include opt out instructions if none were included in the message. Approved examples: STOP, CANCEL, UNSUBSCRIBE, QUIT, or END

October 15, 2024

The Listing All Calls and Retrieving a Single Call endpoints now include the zip_code field, when requested using field selection. zip_code returns all zip codes that were entered by a caller in a geo-routing step of a call flow.

API

Accounts

Within CallRail, accounts are the top level object. Once an account has been created, companies can then be created within a given account and relevant actions like creating tracking numbers and adding users can then be accomplished. The Accounts endpoints retrieve data about which CallRail accounts can be accessed by the given API key. For more information on scoped API keys, see the Authorization section.

Listing All Accounts

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a.json"

The above command returns a JSON structured object like this:

{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 2,
  "accounts": [
    {
      "id": "ACC8154748ae6bd4e278a7cddd38a662f4f",
      "name": "Last Mile Metrics",
      "outbound_recording_enabled": true,
      "hipaa_account": false
    },
    {
      "id": "ACC8154748ae6bd4e278a7cddd38a662d4d",
      "name": "CallRail",
      "outbound_recording_enabled": true,
      "hipaa_account": false
    }
  ]
}

This endpoint returns a paginated array of all accounts scoped to the provided API key.

API Endpoint

Request Parameters

This endpoint supports Offset Pagination, Sorting, and Filtering.

Sorting is available for the following fields:

• name

Filtering is available for the following:

• hipaa_account: true or false

Response Fields

When successful, the HTTP response code will indicate 200 OK.

Additional User Requested Response Fields

Field Selection is available for the following fields.

Retrieving A Single Account

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a/{account_id}.json"

The above command returns a JSON structured object like this:

{
  "id": "ACC8154748ae6bd4e278a7cddd38a662f4f",
  "name": "Last Mile Metrics",
  "outbound_recording_enabled": true,
  "hipaa_account": false
}

This endpoint returns a single account object scoped to the provided API key.

API Endpoint

Response Fields

When successful, the HTTP response code will indicate 200 OK.

Additional User Requested Response Fields

Field Selection is available for the following fields.

Calls

Listing All Calls

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a/{account_id}/calls.json"

The above command returns JSON structured like this:

{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 9,
  "calls": [
    {
      "answered": false,
      "business_phone_number": null,
      "customer_city": "Denver",
      "customer_country": "US",
      "customer_name": "RUEGSEGGER SIMO",
      "customer_phone_number": "+13036231131",
      "customer_state": "CO",
      "direction": "inbound",
      "duration": 4,
      "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
      "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
      "recording_duration": "27",
      "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91eb7f7cc08a4d01ed",
      "start_time": "2017-01-24T11:27:48.119-05:00",
      "tracking_phone_number": "+13038163491",
      "voicemail": false,
      "agent_email": "gil@televised.com"
    },
    {
      "answered": false,
      "business_phone_number": null,
      "customer_city": "Blue Ridge",
      "customer_country": "US",
      "customer_name": "BLUE RIDGE, GA",
      "customer_phone_number": "+17064558047",
      "customer_state": "GA",
      "direction": "inbound",
      "duration": 16,
      "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
      "recording": null,
      "recording_duration": null,
      "recording_player": null,
      "start_time": "2017-01-24T19:50:03.456-05:00",
      "tracking_phone_number": "+17708243899",
      "voicemail": false,
      "agent_email": "elbert@bpp.com"
    }
  ]
}

This endpoint returns a paginated list of all calls in the target account.

API Endpoint

Request Parameters

This endpoint supports Offset Pagination, Sorting, Filtering, Field Selection, and Searching. Please use Relative Pagination when querying larger data sets.

Sorting is available for the following fields:

• customer_name

• customer_phone_number

• duration

• start_time

• source*

• customer_city

• customer_country

• landing_page_url*

• device_type*

• answered

• first_call*

• source_name

• lead_status

• tags*

Note: fields marked with * must be selected to be visible in the response payload as they are not part of the default set of fields.

Filtering is available for the following:

• date_range: See Filtering by Date for more info.

• call_type: first_call, missed, voicemails, inbound, or outbound

• answer_status: answered, missed, or voicemail

• device: desktop or mobile

• direction: inbound or outbound

• lead_status: good_lead, not_a_lead, or not_scored

• tags: This parameter can be provided as tags=A for a single tag, or tags[]=A&tags[]=B to return calls tagged with either tag A or tag B.

Searching is available for the following fields:

• business_phone_number

• customer_name

• customer_number

• note

• source

• tracking_phone_number

Response Fields

When successful, the HTTP response code will indicate 200 OK.

Additional User Requested Response Fields

Field Selection is available for the following fields.

Retrieving a Single Call

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json"

The above command returns JSON structured like this:

 {
  "answered": false,
  "business_phone_number": null,
  "customer_city": "New York City",
  "customer_country": "US",
  "customer_name": "Jimmy Pesto, Sr.",
  "customer_phone_number": "+13036231131",
  "customer_state": "NY",
  "direction": "inbound",
  "duration": 4,
  "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
  "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
  "recording_duration": "27",
  "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91eb7f7cc08a4d01ed",
  "start_time": "2017-01-24T11:27:48.119-05:00",
  "tracking_phone_number": "+13038163491",
  "voicemail": false,
  "agent_email": "gil@televised.com"
}

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json?fields=keywords_spotted,milestones"

The above command returns JSON structured like this:

 {
  "answered": false,
  "business_phone_number": null,
  "customer_city": "New York City",
  "customer_country": "US",
  "customer_name": "Jimmy Pesto, Sr.",
  "customer_phone_number": "+13036231131",
  "customer_state": "NY",
  "direction": "inbound",
  "duration": 4,
  "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
  "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
  "recording_duration": "27",
  "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91eb7f7cc08a4d01ed",
  "start_time": "2017-01-24T11:27:48.119-05:00",
  "tracking_phone_number": "+13038163491",
  "voicemail": false,
  "agent_email": "gil@televised.com",
  "milestones": {
     "first_touch": {
          "event_date": "2017-01-22T19:41:45.183-04:00",
          "ad_position": null,
          "campaign": "US_branded",
          "device": "desktop",
          "keywords": "peststoppers",
          "landing": "https://www.example.com/peststoppers/?campaign=US_branded&keywords=peststoppers&gclid=12345abgdef",
          "landing_page_url_params": {
               "campaign": "US_branded",
               "keywords": "peststoppers",
               "gclid": "12345abgdef"
          },
          "match_type": null,
          "medium": "cpc",
          "referrer": "https://www.google.com/",
          "referrer_url_params": {},
          "session_browser": "Chrome",
          "url_utm_params": {},
          "source": "Google Ads"
      },
     "lead_created": {
          "event_date": "2017-01-22T19:41:45.183-04:00",
          "ad_position": null,
          "campaign": "US_branded",
          "device": "desktop",
          "keywords": "peststoppers",
          "landing": "https://www.example.com/peststoppers/?campaign=US_branded&keywords=peststoppers&gclid=12345abgdef",
          "landing_page_url_params": {
               "campaign": "US_branded",
               "keywords": "peststoppers",
               "gclid": "12345abgdef"
          },
          "match_type": null,
          "medium": "cpc",
          "referrer": "https://www.google.com/",
          "referrer_url_params": {},
          "session_browser": "Chrome",
          "url_utm_params": {},
          "source": "Google Ads"
      },
      "qualified": {
          "event_date": "2017-01-22T19:41:45.183-04:00",
          "ad_position": null,
          "campaign": "US_branded",
          "device": "desktop",
          "keywords": "peststoppers",
          "landing": "https://www.example.com/peststoppers/?campaign=US_branded&keywords=peststoppers&gclid=12345abgdef",
          "landing_page_url_params": {
               "campaign": "US_branded",
               "keywords": "peststoppers",
               "gclid": "12345abgdef"
          },
          "match_type": null,
          "medium": "cpc",
          "referrer": "https://www.google.com/",
          "referrer_url_params": {},
          "session_browser": "Chrome",
          "url_utm_params": {},
          "source": "Google Ads"
       },
     "last_touch": {
          "event_date": "2017-01-24T11:27:48.119-05:00",
          "ad_position": null,
          "campaign": null,
          "device": "desktop",
          "keywords": null,
          "landing": "https://www.example.com/",
          "landing_page_url_params": {},
          "match_type": null,
          "medium": "organic",
          "referrer": "https://www.google.com/",
          "referrer_url_params": {},
          "session_browser": "Chrome",
          "url_utm_params": {},
          "source": "Google Organic"
      }
  },
  "keywords_spotted": [
    {
      "keyword": "test phrase one",
      "locations": [
        {
          "speaker": "caller",
          "start": 7.71
        },
        {
          "speaker": "agent",
          "start": 13.38
        },
        {
          "speaker": "caller",
          "start": 17.96
        }
      ]
    },
    {
      "keyword": "test phrase two",
      "locations": [
        {
          "speaker": "caller",
          "start": 8.44
        }
      ]
    }
  ]
}

This endpoint returns a single call object associated with the target account.

API Endpoint

Request Parameters

This endpoint supports Field Selection.

Response Fields

When successful, the HTTP response code will indicate 200 OK.

Additional User Requested Response Fields

Field Selection is available for the following fields.

Creating an Outbound Phone Call

curl -H "Authorization: Token token={api_token}" \
     -X POST \
     -H "Content-Type: application/json" \
     -d '{
          "caller_id": "+17703334455",
          "business_phone_number": "+14045556666",
          "customer_phone_number": "+14044442233",
          "recording_enabled": true,
          "outbound_greeting_recording_url": "http://www.test.com/greeting.mp3",
          "outbound_greeting_text": "These are not the droids you are looking for."
         }' \
         "https://api.callrail.com/v3/a/{account_id}/calls.json"

This endpoint initiates an outbound call from the target account. It can only be used to place calls to and from US and Canadian numbers. It cannot be used to place calls to the United Kingdom and Australia.

The above command initiates an outbound phone call between a customer and a business. The API call should specify a valid tracking number or verified external number, Outbound Caller ID, as the caller_id. Upon making the request, the first leg of the call is placed to the supplied business_phone_number to iniatate the outbound phone call. Once this call is answered by the business, another outbound dial is made to the customer_phone_number and connected to the initial business phone call.

 {
  "answered": null,
  "business_phone_number": "+19044567899",
  "customer_city": "Atlanta",
  "customer_country": "US",
  "customer_name": null,
  "customer_phone_number": "+14703444700",
  "customer_state": "GA",
  "direction": "outbound",
  "duration": null,
  "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
  "recording": null,
  "recording_duration": null,
  "start_time": "2017-02-22T15:02:24.916-05:00",
  "tracking_phone_number": "+19044567899",
  "voicemail": false
}

API Endpoint

Request Body

Response Fields

When successful, the HTTP response code will indicate 201 CREATED.

Updating a Call

curl -H "Authorization: Token token={api_token}" \
     -X PUT \
     -H "Content-Type: application/json" \
     -v \
     -d '{
           "note": "Call customer back tomorrow",
           "tags": ["New Client"],
           "lead_status": "good_lead",
           "value": "$1.00",
           "append_tags": true,
           "customer_name": "James Smith"
         }' \
        "https://api.callrail.com/v3/a/{account_id}/calls/{call_id}.json"

The above command returns JSON structured object like this:

 {
  "answered": false,
  "business_phone_number": null,
  "customer_city": "Denver",
  "customer_country": "US",
  "customer_name": "James Smith",
  "customer_phone_number": "+13036231131",
  "customer_state": "CO",
  "direction": "inbound",
  "duration": 4,
  "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
  "recording": "https://api.callrail.com/v3/a/227799611/calls/213472384/recording.json",
  "recording_duration": "27",
  "start_time": "2017-01-24T11:27:48.119-05:00",
  "tracking_phone_number": "+13038163491",
  "voicemail": false
}

This endpoint updates a call object in the target account. You can use the API to add a Tag or a Note to a call, to set the call’s lead status, or to update the name of the lead associated with the call.

API Endpoint

Request Body

When updating a call, the following fields may be included in the request body. If a field is not included, its value will not be changed. If it is included but is null or a blank string, the field will be cleared.

Response Fields

When successful, the HTTP response code will indicate 200 OK.

Summarizing Call Data

curl -H "Authorization: Token token=abc1234" \
  https://api.callrail.com/v3/a/{account_id}/calls/summary.json?group_by=source

The above command returns JSON structured like this:

{
  "start_date": "2016-10-10T00:00:00-0000",
  "end_date": "2016-11-09T23:59:59-0000",
  "time_zone": "UTC",
  "total_results": {
    "total_calls": 160
  },
  "grouped_by": "source",
  "grouped_results": [
    {
      "key": "Bing",
      "total_calls": 130,
      "missed_calls": 20,
      "answered_calls": 110,
      "first_time_callers": 15,
      "average_duration": 179,
      "formatted_average_duration": "2m 59s",
      "leads": 40
    },
    {
      "key": "Billboard Ad",
      "total_calls": 30,
      "missed_calls": 4,
      "answered_calls": 26,
      "first_time_callers": 4,
      "average_duration": 45,
      "formatted_average_duration": "45s",
      "leads": 6
    }
  ]
}

Return summarized Call data for an Agency or for a Company. This Call Summary data can be limited to a specific date range, can be filtered based on a variety of criteria, and can be grouped by source, keywords, campaign, referrer, landing_page, or company. Grouping by company is only available when using the account-level endpoint.

API Endpoints

Request Parameters

Date Request Parameters

See Filtering by Date for more info

Searching is available for the following fields:

• source

Response Fields

Summary Data Response Fields

Summarizing Call Data by Time Series

curl -H "Authorization: Token token=abc1234" \
  https://api.callrail.com/v3/a/{account_id}/calls/timeseries.json?start_date=2016-10-01&end_date=2016-10-04&fields=missed_calls,answered_calls,first_time_callers,average_duration,formatted_average_duration,leads

The above command returns JSON structured like this:

{
  "start_date": "2016-10-01T00:00:00-0000",
  "end_date": "2016-10-04T23:59:59-0000",
  "time_zone": "UTC",
  "total_results": {
    "total_calls": 180,
    "missed_calls": 20,
    "answered_calls": 160,
    "first_time_callers": 54,
    "average_duration": 27,
    "formatted_average_duration": "27s",
    "leads": 12
  },
  "data": [
    {
      "date": "2016-10-01",
      "total_calls": 130,
      "missed_calls": 4,
      "answered_calls": 26,
      "first_time_callers": 4,
      "average_duration": 45,
      "formatted_average_duration": "45s",
      "leads": 6
    },
    {
      "date": "2016-10-02",
      "total_calls": 30,
      "missed_calls": 4,
      "answered_calls": 26,
      "first_time_callers": 4,
      "average_duration": 45,
      "formatted_average_duration": "45s",
      "leads": 6
    },
    {
      "date": "2016-10-03",
      "total_calls": 0,
      "missed_calls": 0,
      "answered_calls": 0,
      "first_time_callers": 0,
      "average_duration": 0,
      "formatted_average_duration": "0s",
      "leads": 0
    },
    {
      "date": "2016-10-04",
      "total_calls": 20,
      "missed_calls": 10,
      "answered_calls": 10,
      "first_time_callers": 1,
      "average_duration": 15,
      "formatted_average_duration": "15s",
      "leads": 0
    }
  ]
}

curl -H "Authorization: Token token=abc1234" \
  https://api.callrail.com/v3/a/{account_id}/calls/timeseries.json?start_date=2016-10-01&end_date=2016-10-04&interval=hour&time_zone=EST

The above command returns JSON structured like this: *Note that this returned list is a formatting example only; it is not a full representation of the returned results for a full 24 hour data set.

{
  "start_date": "2016-10-01T00:00:00-0500",
  "end_date": "2016-10-02T23:59:59-0500",
  "time_zone": "EST",
  "total_results": {
    "total_calls": 130
  },
  "data": [
    {
      "date": "2016-10-01T00:00:00-0500",
      "total_calls": 0
    },
    {
      "date": "2016-10-01T01:00:00-0500",
      "total_calls": 0
    },
    {
      "date": "2016-10-01T02:00:00-0500",
      "total_calls": 0
    },
    {
      "date": "2016-10-01T03:00:00-0500",
      "total_calls": 0
    },
    {
      "date": "2016-10-01T04:00:00-0500",
      "total_calls": 0
    },
    {
      "date": "2016-10-01T05:00:00-0500",
      "total_calls": 0
    },
    {
      "date": "2016-10-01T06:00:00-0500",
      "total_calls": 5
    },
    {
      "date": "2016-10-01T07:00:00-0500",
      "total_calls": 20
    }
  ]
}

Retrieve aggregate call data for an account or company, grouped by date. This call data can be limited to a specific date range, filtered based on a variety of criteria, and summarized in several ways.

Time series response data is intended to be displayed as a chart, and is limited to 200 data points. For larger time spans (for example: longer than 3 months), it is recommended to specify a larger interval such as week, month, or year. If hourly or daily data is needed for a longer time period, the query must be broken into multiple requests.

API Endpoints

Request Parameters

Date Request Parameters

See Filtering by Date for more info

Searching is available for the following fields:

• source

Response Fields

Additional User Requested Response Fields

Field Selection is available for the following Summary Data Response fields in the table below.

To choose any or all of the below fields, provide a fields parameter. Please refer Field Selection to see an example.

ex. fields=missed_calls,answered_calls,first_time_callers,average_duration,formatted_average_duration,leads

Retrieving a Single Call Recording

curl -H "Authorization: Token token=abc1234" \
  https://api.callrail.com/v3/a/{account_id}/calls/{call_id}/recording.json

The above command returns JSON structured like this:

{
  "url": "http://app.callrail.com/calls/CAL11df32690b7d46123456789123456789/recording/redirect?access_key=241sa242sadqwerty123"
}

This endpoint returns a CallRail URL pointing to an MP3 recording of the specified call. The link returned does not expire in 24 hours but this does not guarantee the link will be good forever. The link is intended for playback in a client browser or downloading the file to your own storage mechanism.

API Endpoint

Request Parameters

None

Response Fields

Includes the following:

For HIPAA agencies

The above command returns JSON structured like this for HIPAA agencies:

{
  "url": "https://calltrk-production.s3.amazonaws.com/calls/recordings/000/000/700/test.mp3"
}

This endpoint returns a temporary URL pointing to an MP3 recording of the specified call. Because of HIPAA restrictions, the URL returned in the response is not a link. It is intended for immediate use: either playback in a client browser or downloading the file to your own storage mechanism. The URL returned will expire in about 24 hours.

You should never store the URL returned in this response. Instead, you should make a request to this endpoint whenever you need to obtain current location of this MP3. Because the underlying file may move in the future, the permanent reference to this recording is this API endpoint itself.

Response Fields

Includes the following:

Tags

Tags are labels that can be applied to help sort and categorize your calls, form submissions, and text messages. Some tags are company-dependent within your account and there’s no limit on the number of tags a company can have.

If you’re an administrator for your CallRail account, you can create a set of tags that apply to every single company in your account. These tags can only be created and edited by administrators since these tag settings apply to all companies. More than one tag can be assigned to a single call/form submission/text message and these tags will be available on your activity dashboard when a call is received.

Tags can also be applied in the following ways:

• manually added by a CallRail user via the CallRail web application
• added with a Tag step in a Call Flow
• through an Automation Rule

See our Call Flow feature and Tag Step for more information. For example, you can create a call tag named “Sales Call” to be applied when a caller presses option 1 to speak to Sales. Advanced Call Flows must be configured only within the CallRail web application.

Our Automation Rules feature is available to customers who subscribe to our Conversation Intelligence product. For example, you can create a call tag named “Online Ad Campaign Confirmed Appointment” and automatically apply it to calls with a source of Google Ads, when the caller says the phrase “make an appointment.”

Retrieving All Tags

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a/{account_id}/tags.json"

The above command returns a JSON structured object like this:

{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 3,
  "tags": [
    {
      "id": 993186,
      "name": "Conversion",
      "tag_level": "company",
      "color": "gray1",
      "background_color": "green2",
      "company_id": "COM37221d54e80c4216898d2f857fc69fa0",
      "status": "enabled",
      "created_at": "2017-07-24T11:13:47.366-04:00"
    },
    {
      "id": 1932597,
      "name": "Sales",
      "tag_level": "company",
      "color": "gray1",
      "background_color": "blue2",
      "company_id": "COM37221d54e80c4216898d2f857fc69fa0",
      "status": "enabled",
      "created_at": "2019-04-05T13:38:36.258-04:00"
    },
    {
      "id": 2672419,
      "name": "Unanswered",
      "tag_level": "company",
      "color": "gray1",
      "background_color": "yellow1",
      "company_id": "COM37221d54e80c4216898d2f857fc69fa0",
      "status": "enabled",
      "created_at": "2020-10-16T16:07:35.554-04:00"
    }
  ]
}

This endpoint returns a paginated array of tags within the target account.

API Endpoint

Request Parameters

This endpoint supports Offset Pagination and Sorting.

Sorting is available for the following fields:

• name

Response Field

When successful, the HTTP response code will indicate 200 OK.

Creating a Tag

curl -H "Authorization: Token token={api_token}" \
     -X POST \
     -H "Content-Type: application/json" \
     -d '{
           "name": "Existing Customer",
           "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
           "color": "gray1"
        }' \
        "https://api.callrail.com/v3/a/{account_id}/tags.json"

The above command returns a JSON structured object like this:

{
  "id": "1234569",
  "name": "Existing Customer",
  "tag_level": "company",
  "color": "gray1",
  "background_color": "gray1",
  "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
  "status": "enabled",
  "created_at": "2014-06-06T12:11:02.964-04:00"
}

This endpoint creates a single tag object in the target company or account.

API Endpoint

Request Body

Response Fields

Updating a Tag

curl -H "Authorization: Token token={api_token}" \
     -X PUT \
     -H "Content-Type: application/json" \
     -d '{
           "name": "Existing Customer",
           "color": "gray1"
        }' \
        "https://api.callrail.com/v3/a/{account_id}/tags/{tag_id}.json"

The above command returns a JSON structured object like this:

{
  "id": "1234569",
  "name": "Existing Customer",
  "tag_level": "company",
  "color": "gray1",
  "background_color": "gray1",
  "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
  "status": "enabled",
  "created_at": "2014-06-06T12:11:02.964-04:00"
}

This endpoint updates a tag object in the target account. You can use the API to change the name or color of the tag, or change its status.

API Endpoint

Request Body

Response Fields

Removing a Tag

curl -H "Authorization: Token token={api_token}" \
     -X DELETE \
     "https://api.callrail.com/v3/a/{account_id}/tags/{tag_id}.json"

The above command does not return any response data.

This endpoint will delete a tag. Removing a tag will remove it automatically from any call flow and interaction it’s been assigned to. You can use the Updating a Tag endpoint to disable the tag from being applied to new interactions without removing it from any interactions it was previously applied to.

API Endpoint

Response

When successful, the HTTP response code will indicate 204 No Content and no JSON response will be returned.

If the specified notification is not managed by the current authorized user, the response will be 403 Forbidden with the following error message.

{ "error" => "You do not have permission to perform the requested action" }

Available Colors

The Tag Color object represents the color and background color of the tag to be created.

// Create a Tag that is the color gray.

curl -H "Authorization: Token token={api_token}" \
     -X POST \
     -H "Content-Type: application/json" \
     -d '{
           "name": "Existing Customer",
           "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
           "color": "gray1"
        }' \
        "https://api.callrail.com/v3/a/{account_id}/tags.json"

Selecting a Color

To assign a color to a Tag, you’ll select one of the color names from the table below to set as the value of the color object.

Below is a list of all acceptable color names along with their corresponding color and background color hex codes.

Companies

A company in CallRail is a separate entity within your account. Companies are where you create tracking phone numbers, configure integrations, enable email notifications, and handle specific company settings. Calls and other activities are tracked within the context of a company, and reports can be aggregated across all tracking numbers within a company. You can also restrict users’ access to specific companies to limit the data they can interact with or modify.

For example, if you’re a marketing agency looking to keep separate reports for each client you manage, you’d create a separate company for each client. Or, if you’re overseeing calls to a franchise, you can create separate companies for each franchise location.

Listing All Companies

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a/{account_id}/companies.json"

The above command returns JSON structured object like this:

{
  "page": 1,
  "per_page": 250,
  "total_pages": 1,
  "total_records": 3,
  "companies": [
    {
        "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
        "name": "Widget Shop",
        "status": "active",
        "time_zone": "America/New_York",
        "created_at": "2016-06-06T07:06:01.000Z",
        "disabled_at": null,
        "dni_active": true,
        "script_url": "//cdn.callrail.com/companies/183570817/5706dbe6dc972c634a65/12/swap.js",
        "callscribe_enabled": false,
        "lead_scoring_enabled": true,
        "swap_exclude_jquery": null,
        "swap_ppc_override": null,
        "swap_landing_override": null,
        "swap_cookie_duration": 6,
        "swap_cookie_duration_unit": "months",
        "callscore_enabled": false,
        "keyword_spotting_enabled": false,
        "form_capture": true
    },
    {
        "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
        "name": "Bob's Burger",
        "status": "active",
        "time_zone": "America/New_York",
        "created_at": "2017-06-20T09:30:08.676Z",
        "disabled_at": null,
        "dni_active": false,
        "script_url": "//cdn.callrail.com/companies/411892629/1dbf0fc11eabdc04483a/12/swap.js",
        "callscribe_enabled": false,
        "lead_scoring_enabled": true,
        "swap_exclude_jquery": null,
        "swap_ppc_override": null,
        "swap_landing_override": null,
        "swap_cookie_duration": 30,
        "swap_cookie_duration_unit": "days", 
        "callscore_enabled": false,
        "keyword_spotting_enabled": false,
        "form_capture": true
    },
    {
        "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
        "name": "Joe's Icecream",
        "status": "active",
        "time_zone": "America/New_York",
        "created_at": "2016-06-06T07:06:01.000Z",
        "disabled_at": null,
        "dni_active": null,
        "script_url": "//cdn.callrail.com/companies/785622206/81fbf538633804b8dea6/12/swap.js",
        "callscribe_enabled": false,
        "lead_scoring_enabled": true,
        "swap_exclude_jquery": null,
        "swap_ppc_override": null,
        "swap_landing_override": null,
         "swap_cookie_duration": 6,
        "swap_cookie_duration_unit": "months",
        "callscore_enabled": false,
        "keyword_spotting_enabled": false,
        "form_capture": false
    }
  ]
}

This endpoint returns a paginated array of all companies associated with the target account.

API Endpoint

Request Parameters

This endpoint supports Offset Pagination, Sorting, and Filtering.

Sorting is available for the following fields:

• name

Filtering is available for the following:

• status: active or disabled

Searching is available for the following fields:

• name

Response Fields

When successful, the HTTP response code will indicate 200 OK.

Additional User Requested Response Fields

Field Selection is available for the following fields.

Retrieving a Single Company

curl -H "Authorization: Token token={api_token}" \
     -X GET \
     "https://api.callrail.com/v3/a/{account_id}/companies/{company_id}.json"

The above command returns JSON structured object like this:

{
    "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "name": "Widget Shop",
    "status": "active",
    "time_zone": "America/New_York",
    "created_at": "2016-06-06T07:06:01.000Z",
    "disabled_at": null,
    "dni_active": true,
    "script_url": "//cdn.callrail.com/companies/183570817/5706dbe6dc972c634a65/12/swap.js",
    "callscore_enabled": false,
    "lead_scoring_enabled": true,
    "swap_exclude_jquery": null,
    "swap_ppc_override": null,
    "swap_landing_override": null,
    "swap_cookie_duration": 6,
    "swap_cookie_duration_unit": "months",
    "callscribe_enabled": false,
    "keyword_spotting_enabled": false,
    "form_capture": true
}

This endpoint returns a single company object associated with the target account.

API Endpoint

Response Fields

When successful, the HTTP response code will indicate 200 OK.

Additional User Requested Response Fields

Field Selection is available for the following fields.

Creating a Company

curl -H "Authorization: Token token={api_token}" \
     -X POST \
     -H "Content-Type: application/json" \
     -d '{
          "name": "Widget Shop",
          "time_zone": "America/New_York"
         }' \
         "https://api.callrail.com/v3/a/{account_id}/companies.json"

The above command returns JSON structured object like this:

{
  "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
  "name": "Widget Shop",
  "status": "active",
  "time_zone": "America/New_York",
  "created_at": "2017-01-26T22:58:04.184Z",
  "disabled_at": null,
  "dni_active": null,
  "script_url": "//cdn.callrail.com/companies/279054151/a74c824140d67442debd/12/swap.js",
  "callscribe_enabled": false,
  "lead_scoring_enabled": false,
  "swap_exclude_jquery": null,
  "swap_ppc_override": null,
  "swap_landing_override": null,
  "swap_cookie_duration": 6,
  "swap_cookie_duration_unit": "months",
  "callscore_enabled": false,
  "keyword_spotting_enabled": false
}

This endpoint creates a company object within the target account.

API Endpoint

Request Body

Response Fields

When successful, the HTTP response code will indicate 201 CREATED.

Updating a Company

curl -H "Authorization: Token token={api_token}" \
     -X PUT \
     -H "Content-Type: application/json" \
     -d '{
          "swap_ppc_override": "true",
          "swap_landing_override": "utm_source",
          "callscribe_enabled": true,
          "external_form_capture": true
         }' \
         "https://api.callrail.com/v3/a/{account_id}/companies/{company_id}.json"

The above command returns JSON structured object like this:

{
  "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
  "name": "Widget Shop",
  "status": "active",
  "time_zone": "America/New_York",
  "created_at": "2017-01-26T22:58:04.184Z",
  "disabled_at": null,
  "dni_active": true,
  "script_url": "//cdn.callrail.com/companies/279054151/a74c824140d67442debd/12/swap.js",
  "callscribe_enabled": true,
  "lead_scoring_enabled": false,
  "swap_exclude_jquery": null,
  "swap_ppc_override": true,
  "swap_landing_override": "utm_source",
  "swap_cookie_duration": 6,
  "swap_cookie_duration_unit": "months", 
  "callscore_enabled": false,
  "keyword_spotting_enabled": false,
  "form_capture": true
}

This endpoint updates a company object within the target account.

API Endpoint

Request Body

Response Fields

When successful, the HTTP response code will indicate 200 OK.