For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Homepage Product Help Log in Try for Free

Developers Home API Reference MCP

Skip to navigation

CRM Configuration

Lead Statuses

Lead statuses are a customizable list of stages a Lead can be in

||View as Markdown|

Lead statuses are a customizable list of stages a Lead can be in.

Was this page helpful?

Delete an opportunity status

List lead statuses for your organization

Developers Home API Reference MCP

Getting Started
CRM Core
Activities
Events & Webhooks
- Webhooks
- Events
Search & Reporting
Automation & Bulk Actions
CRM Configuration
Communication Configuration
Users & Organizations

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
Leads
List Leads
Create a new lead
Merge two leads
Get a single Lead
Update an existing lead
Delete a lead
List files attached to a lead
Attach a file to a lead
Contacts
List contacts
Create a new contact
Fetch a single contact
Update an existing contact
Delete a contact
Opportunities
List or filter opportunities
Create an opportunity
Retrieve an opportunity
Update an opportunity
Delete an opportunity
Tasks
List or filter tasks
Create a task
Bulk-update tasks
Fetch a task's details
Update a task
Delete a task
Files
Generate a signed S3 POST
Custom Objects
List Custom Object instances
Create a new Custom Object instance
Retrieve a single Custom Object instance
Updating a Custom Object instance
Delete a Custom Object instance
Comments
Fetch multiple comments
Create a Comment
Fetch an individual comment
Update a Comment
Remove a comment
Fetch multiple comment threads
Fetch an individual comment thread
Activities
List or filter all activity types
Notes
List or filter all Note activities
Create a Note activity
Get a single Note activity
Update a Note activity
Delete a Note activity
Calls
List or filter all Call activities
Log an external Call activity
Get a single Call activity
Update a Call activity
Delete a Call activity
Emails
List or filter all Email activities
Create an Email activity
Get a single Email activity
Update an Email activity
Delete an Email activity
Email Threads
List or filter all EmailThread activities
Get a single EmailThread activity
Delete an EmailThread activity
List or filter all SMS activities
Create an SMS activity
Get a single SMS activity
Update an SMS activity
Delete an SMS activity
WhatsApp Messages
List or filter all WhatsAppMessage activities
Create a WhatsAppMessage activity
Get a single WhatsAppMessage activity
Update a WhatsAppMessage activity
Delete a WhatsAppMessage activity
Meetings
Meeting Search
List or filter all Meeting activities
Get a single Meeting activity
Update a Meeting activity
Delete a Meeting activity
Create or update third-party Meeting integration
Custom Activities
List or filter all Custom Activity instances
Create a new Custom Activity instance
Get a single Custom Activity instance
Updating a Custom Activity instance
Delete a Custom Activity instance
Creations
List or filter all Created activities
Get a single Created activity
Form Submissions
List or filter all FormSubmission activities
Get a single FormSubmission activity
Delete a FormSubmission activity
Lead Status Changes
List or filter all LeadStatusChange activities
Create a new LeadStatusChange activity
Get a single LeadStatusChange activity
Delete a single LeadStatusChange activity
Opportunity Status Changes
List or filter all OpportunityStatusChange activities
Create a new OpportunityStatusChange activity
Get a single OpportunityStatusChange activity
Delete a single OpportunityStatusChange activity
Lead Merges
List or filter all LeadMerge activities
Get a single LeadMerge activity
Task Completions
List or filter all TaskCompleted activities
Get a single TaskCompleted activity
Delete a TaskCompleted activity
Import Updates
List or filter all ImportUpdate activities
Get a single ImportUpdate activity
Delete an ImportUpdate activity
Webhooks
Webhook Filters
List Webhook subscriptions
Create new Webhook subscription
Retrieve a single Webhook subscription
Update existing Webhook subscription
Delete Webhook subscription
Events
List of Event Types
Retrieve a list of events
Retrieve a single event by ID
Advanced Filtering
Smart Views
List Smart Views
Create a Smart View
Get a single Smart View
Update a Smart View
Delete a Smart View
Reporting
Get an activity report
List the predefined metrics used in activity reports
Get custom report (Explorer)
Get a funnel report (stages)
Get a funnel report (totals)
Get sent emails report
Get lead status change report
Get opportunity status change report
Sequences (Workflows)
List Sequences
Create a Sequence
Fetch a Sequence
Update a Sequence
Delete a Sequence
List Sequence Subscriptions
Subscribe a Contact to a Sequence
Fetch a single Sequence Subscription
Update a specific Subscription
Delete a Sequence Subscription
Bulk Actions
List bulk emails
Initiate a new bulk email
Fetch a single bulk email object
List bulk edits
Initiate a new bulk edit
Fetch a single bulk edit object
List bulk deletes
Initiate a new bulk delete
Fetch a single bulk delete object
List bulk sequence subscriptions
Initiate a new bulk sequence subscription
Fetch a single bulk sequence subscription object
Exports
List all the exports
List Lead Exports
Export leads based on a search query
Get a single Lead Export
List Opportunity Exports
Export opportunities, based on opportunity filters
Get a single Opportunity Export
Get a single Export
AI Field Enrichment
Enrich a specific field on a lead or contact using AI
Custom Fields
Custom Field Schemas
Retrieve a custom field schema
Update a custom field schema
List Lead Custom Fields
Create a new Lead Custom Field
Fetch Lead Custom Field's details
Update a Lead Custom Field
Delete a Lead Custom Field
List Contact Custom Fields
Create a new Contact Custom Field
Fetch Contact Custom Field's details
Update a Contact Custom Field
Delete a Contact Custom Field
List Opportunity Custom Fields
Create a new Opportunity Custom Field
Fetch Opportunity Custom Field's details
Update an Opportunity Custom Field
Delete an Opportunity Custom Field
List Activity Custom Fields
Create a new Activity Custom Field
Fetch Activity Custom Field's details
Update an Activity Custom Field
Delete an Activity Custom Field
List Custom Object Custom Fields
Create a new Custom Object Custom Field
Fetch Custom Object Custom Field's details
Update a Custom Object Custom Field
Delete a Custom Object Custom Field
Shared Custom Fields
List Shared Custom Fields
Create a new Shared Custom Field
Fetch Shared Custom Field's details
Update a Shared Custom Field
Delete a Shared Custom Field
Associate a Shared Custom Field with an object type
Fetch a Shared Custom Field Association
Update an existing Shared Custom Field Association
Disassociate a Shared Custom Field from an object type
Custom Activity Types
List Custom Activity Types
Create new Custom Activity Type
Retrieve a single Custom Activity Type
Update existing Custom Activity Type
Delete a Custom Activity Type
Custom Object Types
List Custom Object Types
Create new Custom Object Type
Retrieve a single Custom Object Type
Update existing Custom Object Type
Delete a Custom Object Type
Pipelines
List Pipelines for your organization
Create a Pipeline
Fetch a single Pipeline
Update a Pipeline
Delete a Pipeline
Opportunity Statuses
List opportunity statuses for your organization
Create an opportunity status
Fetch a single opportunity status
Rename an opportunity status
Delete an opportunity status
Lead Statuses
List lead statuses for your organization
Create a new status that can be applied to leads
Fetch a single lead status
Rename a lead status
Delete a lead status
Integration Links
Get all integration links for your organization
Create an integration link
Get a single integration link
Update an integration link
Delete an integration link
Forms
List Forms
Retrieve a Form
Email Templates
List email templates
Create an email template
Fetch an email template
Update an email template
Delete an email template
Render an email template
SMS Templates
List SMS templates
Create an SMS template
Fetch an SMS template
Update an SMS template
Delete an SMS template
Outcomes
List or filter outcomes
Create an outcome
Fetch a single outcome
Update an outcome
Delete an outcome
Playbooks
List or filter playbooks
Create a playbook
Fetch a single playbook
Update a playbook
Delete a playbook
Archive a playbook
Unarchive a playbook
Scheduling Links Guide
Scheduling Links
List User Scheduling Links
Create a User Scheduling Link
Create or update a Scheduling Link via OAuth
Delete a User Scheduling Link via OAuth integration
Fetch a User Scheduling Link
Update a User Scheduling Link
Delete a User Scheduling Link
List Shared Scheduling Links
Create a Shared Scheduling Link
Fetch a Shared Scheduling Link
Update a Shared Scheduling Link
Delete a Shared Scheduling Link
Map a Shared Scheduling Link
Unmap a Shared Scheduling Link
Connected Accounts
List connected accounts
Fetch a single connected account
Send As
List Send As Associations
Create a Send As Association
Delete a Send As Association by allowed user
Edit Send As Associations in bulk
Retrieve a single Send As Association
Delete a Send As Association by ID
Unsubscribed Emails
List all unsubscribed emails
Unsubscribe an email address
Resubscribe an email address
Phone Numbers
List or search for phone numbers
Request an internal phone number
Retrieve a single phone number
Update a phone number
Delete a phone number
Blocked Phone Numbers
List Blocked Phone Numbers
Create a Blocked Phone Number
Retrieve Blocked Phone Number settings
Update Blocked Phone Number settings
Retrieve a single Blocked Phone Number
Update a Blocked Phone Number
Delete a Blocked Phone Number
Dialers
List or filter all dialer sessions
Get a single dialer session
Users
Fetch information about yourself
List users in your organization
List user availability statuses
Fetch a single user
Organizations
Get an organization's details
Update an organization
Memberships
Create a membership
Bulk update memberships
Update a membership
Delete a membership
Get pinned views for a membership
Update pinned views for a membership
Roles
List all the roles defined for your organization
Create a new role
Fetch a single role
Update existing role
Delete a role
Groups
List Groups for your organization
Create a Group
Add a User to a Group
Remove a User from a Group
Fetch an individual Group
Update a Group
Delete a Group

Product

Overview Communication Automation Integrations Reporting SMS Calling Security Forms

Pricing & Use Cases

Pricing Close vs Other CRMs Customer Stories

Resources

Sales Blog Sales Resources Sales Guides Webinars On-Demand Demo Sales Tools

Company

About Careers Partner with Close Brand Guidelines Terms Privacy GDPR CCPA

Get Help

+1-833-GO-CLOSE Help Center Download the Close App Product Updates System Status