How to Use V3 Public APIs for Countdown Timers
Chat To Clients CRM's V3 Public APIs for Countdown Timers allow developers to create, retrieve, update, and delete timers programmatically. These APIs support fixed, dynamic, and recurring timers, along with advanced styling, template browsing, and filtering options. This article explains the available API operations and how to manage countdown timers through integrations.
TABLE OF CONTENTS
- What Are the V3 Countdown Timer APIs?
- Key Benefits of V3 Countdown Timer APIs
- Supported Countdown Timer Types
- Available Countdown Timer API Operations
- Timer Templates and Design Customization
- Filtering, Pagination, and API Responses
- How to Use the V3 Countdown Timer APIs
- Frequently Asked Questions
- Related Articles
What Are the V3 Countdown Timer APIs?
The V3 Countdown Timer APIs provide programmatic access to countdown timer management in Chat To Clients CRM. Developers can manage the entire timer lifecycle without manually configuring each timer through the interface.
The APIs use token-resolved authentication, eliminating the need to include locationId in the endpoint URL. Responses also provide richer information, including design metadata, preview and tracking links, and thumbnails.
Key Benefits of V3 Countdown Timer APIs
The V3 APIs simplify countdown timer management and give developers greater control over timer configurations and integrations.
Full Lifecycle Management: Create, retrieve, update, and soft-delete timers programmatically.
Multiple Timer Types: Manage fixed, dynamic, and recurring countdown timers.
Template Access: Browse shared timer templates for faster setup.
Advanced Customization: Configure timer appearance using
designMeta.Flexible Filtering: Search and filter timers with pagination.
Simplified API Access: Use token-resolved endpoints without
locationIdin the URL.Enhanced Responses: Access design metadata, preview and tracking links, and thumbnails.
Supported Countdown Timer Types
The V3 APIs support three countdown timer types, allowing developers to configure timers for different campaign requirements.
| Timer Type | Description |
|---|---|
| Fixed | Counts down to a specific date and time. |
| Dynamic | Starts based on an individual contact's activity or trigger. |
| Recurring | Repeats according to a configured countdown schedule. |
Dynamic timers support the following API triggers:
sent— Email sent.opened— Email opened.whatsapp_sent— WhatsApp message sent.whatsapp_opened— WhatsApp opened trigger.
For more information, see Guide: Dynamic Countdown Timer.
Available Countdown Timer API Operations
The V3 APIs provide six operations for managing countdown timers and accessing the shared template catalog.
| API Operation | Function |
|---|---|
| List Countdown Timers | Retrieve timers with filtering and pagination. |
| Create Countdown Timer | Create fixed, dynamic, or recurring timers. |
| Get Countdown Timer | Retrieve an existing timer by ID. |
| Update Countdown Timer | Modify timer configurations using PATCH. |
| Delete Countdown Timer | Soft-delete an existing timer. |
| List Timer Templates | Browse available countdown timer templates. |
Note: Deletion uses a soft-delete operation. Restoration capabilities are not established by this release.
Timer Templates and Design Customization
The V3 APIs allow developers to browse shared countdown timer templates and configure timer appearance programmatically. This helps maintain consistent branding across campaigns and integrations.
The designMeta configuration supports settings such as:
Fonts and text styling
Colors and labels
Countdown unit visibility
Borders and padding
Additional timer design properties
Developers can retrieve available templates and use the applicable configuration options when creating or updating timers.
Filtering, Pagination, and API Responses
The List Countdown Timers API supports filtering and pagination, making it easier to retrieve and manage timers across larger collections.
Available filtering capabilities include:
Timer type
Timer status
Search term
Expiry
Pagination
API responses also provide additional timer information, including design metadata, preview and tracking links, and thumbnails.
How to Use the V3 Countdown Timer APIs
Developers can use the V3 APIs to manage countdown timers through authenticated integrations. The correct API permissions and request parameters are essential for successful operations.
Configure API Access: Set up authentication and the required permissions for your application.
Browse Templates: Use the List Timer Templates API to explore available designs.
Create a Timer: Use the Create Countdown Timer API and select the appropriate timer type.
Customize the Timer: Configure supported styling properties using
designMeta.Retrieve Timers: Use the List or Get API to access existing timer information.
Update Timers: Use the PATCH endpoint to modify supported settings.
Delete Timers: Use the Delete API when a timer is no longer needed.
The API resolves the relevant sub-account from the authorized token rather than requiring locationId in the endpoint URL.
For authentication guidance, refer to How to Get Started with the Developer's Marketplace.
Frequently Asked Questions
Q: Which countdown timer types are supported?
The V3 APIs support fixed, dynamic, and recurring countdown timers.
Q: Can I manage timers without using the Chat To Clients CRM interface?
Yes. Developers can create, retrieve, update, and delete countdown timers programmatically.
Q: Is locationId required in the API URL?
No. The new APIs resolve sub-account context through the authentication token.
Q: Can I customize timer appearance through the API?
Yes. The designMeta configuration supports fonts, colors, labels, unit visibility, borders, padding, and other styling properties.
Q: Can I retrieve available timer templates?
Yes. The List Timer Templates API provides access to the shared timer template catalog.
Q: Do the APIs support filtering and pagination?
Yes. The List Countdown Timers API supports filtering by type, status, search term, and expiry, along with pagination.
Q: What happens when I delete a timer through the API?
The API performs a soft-delete operation. The release does not specify whether deleted timers can be restored.