For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomepageProduct HelpLog inTry for Free
Developers HomeAPI ReferenceMCP
Developers HomeAPI ReferenceMCP
  • Getting Started
    • Introduction
    • Authentication with API Keys
    • Authentication with OAuth
    • API Clients
    • Pagination
    • Specifying Fields
    • Filter Parameters
    • HTTP Response Codes
    • Rate Limits
    • Timezone Offsets
    • Rich Text Fields
    • Changelog
  • CRM Core
    • Leads
    • Contacts
    • Opportunities
    • Tasks
    • Files
    • Custom Objects
    • Comments
  • Activities
    • Activities
    • Notes
    • Calls
    • Emails
    • Email Threads
    • WhatsApp Messages
    • Meetings
    • Custom Activities
    • Creations
    • Form Submissions
    • Lead Status Changes
    • Opportunity Status Changes
    • Lead Merges
    • Task Completions
  • Events & Webhooks
    • Webhooks
    • Events
  • Search & Reporting
    • Advanced Filtering
    • Smart Views
    • Reporting
  • Automation & Bulk Actions
    • Sequences (Workflows)
    • Bulk Actions
    • Exports
    • AI Field Enrichment
  • CRM Configuration
    • Custom Fields
    • Custom Activity Types
    • Custom Object Types
    • Pipelines
    • Opportunity Statuses
    • Lead Statuses
    • Integration Links
    • Forms
  • Communication Configuration
    • Email Templates
    • SMS Templates
    • Outcomes
    • Playbooks
    • Scheduling Links Guide
    • Scheduling Links
    • Connected Accounts
    • Send As
    • Unsubscribed Emails
    • Phone Numbers
    • Blocked Phone Numbers
    • Dialers
  • Users & Organizations
    • Users
    • Organizations
    • Memberships
    • Roles
    • Groups
Close

Product

OverviewCommunicationAutomationIntegrationsReportingSMSCallingSecurityForms

Pricing & Use Cases

PricingClose vs Other CRMsCustomer Stories

Resources

Sales BlogSales ResourcesSales GuidesWebinarsOn-Demand DemoSales Tools

Company

AboutCareersPartner with CloseBrand GuidelinesTermsPrivacyGDPRCCPA

Get Help

+1-833-GO-CLOSEHelp CenterDownload the Close AppProduct UpdatesSystem Status
LogoLogo
HomepageProduct HelpLog inTry for Free
Getting Started

API Changelog


As we make changes to our API, we’ll publish below. Changes to the product itself will be published on Product Updates.

May 7, 2026
May 7, 2026

Forms API

We have added the Forms API.

You can now list the forms your team has built in Close and inspect their field definitions, including field types and select-field choices.


May 4, 2026
May 4, 2026

Playbooks API

We have added a new Playbooks API for managing playbooks — reusable templates that standardize how your team conducts calls and meetings.


April 10, 2026
April 10, 2026

Blocked Phone Numbers API

We have added a new Blocked Phone Numbers API, which lets you manage a list of phone numbers that should be blocked from calling or messaging within your organization.


April 6, 2026
April 6, 2026

March 6, 2026
March 6, 2026

January 14, 2026
January 14, 2026

December 17, 2025
December 17, 2025

August 25, 2025
August 25, 2025

August 14, 2025
August 14, 2025

Transcription related fields in Meeting API

We have added the transcripts field to responses in the Meeting API.


July 29, 2025
July 29, 2025

Older posts

Next
Built with

OpenAPI Spec now available

We now publish an OpenAPI spec for the Close API at: https://api.close.com/api/openapi.json

This spec is currently considered experimental and does not yet contain 100% coverage of request/response schemas. If you have any feedback or use cases you’d like to share, please let us know by emailing support@close.com.

applies_to field on Outcomes deprecated for write operations

The applies_to field on the Outcome API is now deprecated on write operations (create and update). In a future update, the field will be ignored on create and update requests and will instead be derived from the type field:

  • When type is custom, applies_to will always be ["calls", "meetings"].
  • When type is vm-dropped, applies_to will be ["calls"].

The applies_to field will continue to be returned in read responses. No changes are needed for integrations that only read this field.

Form Submissions API

We have added support for Form Submissions as a new activity type. Form Submissions are created by the system whenever someone fills out a Close Form.

We also introduced new events activity.form_submission.created, activity.form_submission.updated, and activity.form_submission.deleted, which you can subscribe to using webhooks.

Sender field requirements for Email activities

We fixed a bug in the Email API that previously allowed creating emails without a sender in cases where a sender is required.

The sender field is required for emails with status inbox, scheduled, outbox, or error. It may be omitted in the following cases:

  • For draft, since the sender can be specified later before sending.
  • For sent, where it defaults to the email address of the user associated with the email or the owner of the API key.

When updating a draft’s status to scheduled or outbox, the sender field is now required if the email doesn’t have one yet.

Note titles and pinned_at timestamps

You can now set a Note’s title field when creating or updating a Note via the Note API.

We have also added the title and pinned_at fields to responses in the Note API.

Outcome API

We have introduced the Outcome API which allows you to organize & manage outcomes, i.e. standardized results that can be applied to activities such as calls and meetings.

Outcomes can help sales teams track and categorize the results of their interactions with prospects and customers.