Use these endpoints to log phone calls made in outside systems, search calls made or received through Apollo's dialer, and update calls in your team's Apollo workspace. You can also associate calls with saved contacts and accounts, and record call details such as status, duration, purpose, outcome, and notes.
Key concepts
| Call records and dialing | Call records store information about phone calls. The dialer lets your team make and receive calls in Apollo. These endpoints manage call records; creating a call record doesn't dial the prospect. |
| Identifying a call | Search and create responses return a call record id that you can pass to update the call. Retain the Apollo call ID in your system if you need to change the record later. |
| Contacts, accounts, and callers | Use saved contact and account IDs to associate a call with the person or company involved. Use an Apollo user ID to identify the team member who made the call. |
| Status, purpose, and outcome | Status describes the call's state, such as completed or unanswered. Purpose describes why the call was made; outcome records its result. Call purpose and outcome IDs are specific to your team's workspace. |
Choose an endpoint
| I want to . . . | Use this |
|---|---|
| Log a call made through an outside system | Create call records |
| Find calls made or received through Apollo's dialer | Search for calls |
| Change a call's details, associations, purpose, outcome, or notes | Update call records |
Example workflows
Log an external call for a contact
Bring a call made in another system into Apollo so your team can keep its activity associated with the right contact.
- Call search for contacts to find the saved contact and retain their
id. - Call get a list of users and retain the ID of the team member who made the call.
- Call create call records with
loggedset totrue, the contact ID ascontact_id, and the caller's user ID inuser_id[]. Include the call details you want to save, such asto_number,status,duration, andnote. - Retain the returned call record
idto update it later.
Enter duration in seconds. If you include start_time or end_time, use ISO 8601 date-time values with the appropriate time zone.
Learn more: Use the create call records reference to explore the call fields available.
Review and update call details
Find a call in Apollo and update its notes or outcome after reviewing what happened.
- Call search for calls with filters such as date range, caller, or duration. Identify the call you want to change and retain its
id. - Pass that ID as
idto update call records, along with the changes. For example, usenoteto record follow-up context orphone_call_outcome_idto assign an outcome.
Use your workspace's outcome ID rather than an outcome name. If you already have the call record ID, you can skip search.
Learn more: Use the search for calls and update call records references to dig in to the workflow.