Table of Contents
ChurnZero is the Customer Success Software built for growing SaaS and subscription businesses. Fight customer churn & expand current accounts.
API Overview
Churnzero is a customer success platform that helps businesses reduce churn and increase customer lifetime value. It provides a comprehensive suite of tools to help businesses track customer engagement, identify at-risk customers, and take proactive steps to prevent churn. Churnzero integrates with a variety of CRM and marketing automation systems, making it easy for businesses to get a complete view of their customer data. It also offers a powerful API that allows businesses to build custom integrations and extend the functionality of the platform.
The Churnzero API provides a comprehensive set of REST APIs that allow developers to access and manage all aspects of the platform. The API is well-documented and easy to use, making it a great choice for businesses looking to integrate Churnzero with their own systems. In addition to REST APIs, Churnzero also offers a set of webhooks that allow businesses to receive real-time notifications of important events, such as when a customer cancels their subscription. The API also includes rate limits to ensure that businesses do not overwhelm the system with excessive requests.
API Request Limits
Free
100 requests per minute
Growth
500 requests per minute
Professional
1000 requests per minute
Enterprise
2000 requests per minute
SDKs
APIs
Method: GET
Description: Returns a single account..
Endpoint: https://app.churnzero.net/api/v3/accounts/{account_id}
Parameters: account_id
Method: POST
Description: Creates an account..
Endpoint: https://app.churnzero.net/api/v3/accounts
Parameters: name, email_address, details
Method: PATCH
Description: Updates a single account..
Endpoint: https://app.churnzero.net/api/v3/accounts/{account_id}
Parameters: name, email_address, details
Method: GET
Description: Returns a list of accounts..
Endpoint: https://app.churnzero.net/api/v3/accounts
Parameters: page, per_page, search
Method: GET
Description: Returns a single company..
Endpoint: https://app.churnzero.net/api/v3/companies/{company_id}
Parameters: company_id
Method: POST
Description: Creates a company..
Endpoint: https://app.churnzero.net/api/v3/companies
Parameters: name, email_address, details
Method: PATCH
Description: Updates a single company..
Endpoint: https://app.churnzero.net/api/v3/companies/{company_id}
Parameters: name, email_address, details
Method: GET
Description: Returns a list of companies..
Endpoint: https://app.churnzero.net/api/v3/companies
Parameters: page, per_page, search
Method: GET
Description: Returns a single contact..
Endpoint: https://app.churnzero.net/api/v3/contacts/{contact_id}
Parameters: contact_id
Method: POST
Description: Creates a contact..
Endpoint: https://app.churnzero.net/api/v3/contacts
Parameters: first_name, last_name, email_address, phone_number, job_title, company_id, account_id, details
Method: PATCH
Description: Updates a single contact..
Endpoint: https://app.churnzero.net/api/v3/contacts/{contact_id}
Parameters: first_name, last_name, email_address, phone_number, job_title, company_id, account_id, details
Method: GET
Description: Returns a list of contacts..
Endpoint: https://app.churnzero.net/api/v3/contacts
Parameters: page, per_page, search, company_id, account_id
Method: GET
Description: Returns a single event..
Endpoint: https://app.churnzero.net/api/v3/events/{event_id}
Parameters: event_id
Method: POST
Description: Creates a event..
Endpoint: https://app.churnzero.net/api/v3/events
Parameters: type, occured_at, contact_id, details
Method: PATCH
Description: Updates a single event..
Endpoint: https://app.churnzero.net/api/v3/events/{event_id}
Parameters: type, occured_at, contact_id, details
Method: GET
Description: Returns a list of events..
Endpoint: https://app.churnzero.net/api/v3/events
Parameters: page, per_page, search, contact_id
Method: GET
Description: Returns a single note..
Endpoint: https://app.churnzero.net/api/v3/notes/{note_id}
Parameters: note_id
Method: POST
Description: Creates a note..
Endpoint: https://app.churnzero.net/api/v3/notes
Parameters: contact_id, company_id, account_id, title, body
Method: PATCH
Description: Updates a single note..
Endpoint: https://app.churnzero.net/api/v3/notes/{note_id}
Parameters: contact_id, company_id, account_id, title, body
Method: GET
Description: Returns a list of notes..
Endpoint: https://app.churnzero.net/api/v3/notes
Parameters: page, per_page, search, contact_id, company_id, account_id
FAQ
How do I get started with the Churnzero APIs?
To get started, you will need to create a developer account on our website and obtain an API key.
What are the rate limits for the Churnzero APIs?
The rate limits for the Churnzero APIs vary depending on the specific API endpoint. You can find the rate limits for each endpoint in the API documentation.
How do I authenticate to the Churnzero APIs?
You can authenticate to the Churnzero APIs using an API key. The API key should be passed in the Authorization header of your API requests.
What is a sandbox account?
A sandbox account is a special type of account that allows you to test the Churnzero APIs without affecting your live data.
How do I create a sandbox account?
You can create a sandbox account by contacting our support team.