Table of Contents
Integrate CleverTap's advanced customer engagement platform into your apps using its comprehensive API. Manage user profiles, automate push notifications, and create custom segments while leveraging real-time webhooks.
API Overview
CleverTap is a leading customer engagement and user retention platform that helps businesses maximize user engagement, drive growth, and improve customer lifetime value. It provides a comprehensive suite of features, including personalized push notifications, in-app messaging, email campaigns, segmentation, and analytics. CleverTap's advanced machine learning algorithms and AI-powered recommendations enable businesses to deliver highly targeted and relevant experiences to their users, resulting in increased engagement, conversions, and revenue. With a global presence and a team of experts dedicated to customer success, CleverTap empowers businesses to build lasting relationships with their customers and achieve their marketing goals.
CleverTap offers a robust API suite that provides developers with the flexibility and control to integrate CleverTap's functionality into their applications and workflows. The API documentation provides comprehensive guidance on all aspects of the API, including authentication, resource endpoints, request and response formats, and error handling. The REST APIs allow developers to programmatically manage user profiles, send notifications, create segments, and perform various other operations. Webhooks enable real-time event notifications to be sent to external systems, facilitating seamless integration with third-party tools and services. To ensure optimal performance and prevent abuse, CleverTap implements rate limits on API requests, which can be adjusted based on specific requirements.
API Request Limits
Free
500 requests per minute
Growth
1000 requests per minute
Pro
2000 requests per minute
Enterprise
Custom rate limits
SDKs
APIs
Method: POST
Description: Logs event details back to CleverTap..
Endpoint: https://api.clevertap.com/1/events.json
Parameters: event_name, profile_property, event_property
Method: PUT
Description: Updates user profile property values..
Endpoint: https://api.clevertap.com/1/profile.json
Parameters: identity, profile_property, access_token, profile_push_sound, profile_push_vibrate, profile_push_badge, profile_email_notification, profile_sms_notification, profile_in_app_notification
Method: GET
Description: Fetches user profile details..
Endpoint: https://api.clevertap.com/1/profile.json
Parameters: identity, access_token
Method: POST
Description: Creates user profile and/or updates user profile property values..
Endpoint: https://api.clevertap.com/1/profile.json
Parameters: identity, profile_property, access_token, profile_push_sound, profile_push_vibrate, profile_push_badge, profile_email_notification, profile_sms_notification, profile_in_app_notification
Method: GET
Description: Fetches the details of an app. (Requires a Master Admin Token).
Endpoint: https://api.clevertap.com/1/app.json
Parameters: access_token
Method: GET
Description: Fetches an individual campaign details..
Endpoint: https://api.clevertap.com/1/campaigns.json
Parameters: id, access_token
Method: PUT
Description: Used to update a campaign..
Endpoint: https://api.clevertap.com/1/campaigns.json
Parameters: id, name, status, access_token, trigger_date, trigger_time, campaign_message, schedule_type, min_app_version, max_app_version, throttle_secs, daily_cap, offer_id, offer_terms, offer_url, offer_image, offer_expiry, display_order, send_at, allow_duplicate, send_now, campaign_snapshot_id, auto_cancel_on_conversion
Method: POST
Description: Used to create a new campaign..
Endpoint: https://api.clevertap.com/1/campaigns.json
Parameters: name, status, access_token, trigger_date, trigger_time, campaign_message, schedule_type, min_app_version, max_app_version, throttle_secs, daily_cap, offer_id, offer_terms, offer_url, offer_image, offer_expiry, display_order, send_at, allow_duplicate, send_now, campaign_snapshot_id, auto_cancel_on_conversion
Method: DELETE
Description: Used to delete an existing campaign..
Endpoint: https://api.clevertap.com/1/campaigns.json
Parameters: id, access_token
Method: GET
Description: Fetches an individual segment details..
Endpoint: https://api.clevertap.com/1/segments.json
Parameters: id, access_token
Method: PUT
Description: Used to update a segment..
Endpoint: https://api.clevertap.com/1/segments.json
Parameters: id, name, description, type, code, access_token, user_audience
Method: POST
Description: Used to create a new segment..
Endpoint: https://api.clevertap.com/1/segments.json
Parameters: name, description, type, code, access_token, user_audience
Method: DELETE
Description: Used to delete an existing segment..
Endpoint: https://api.clevertap.com/1/segments.json
Parameters: id, access_token
Method: GET
Description: Fetches the details of a goal..
Endpoint: https://api.clevertap.com/1/goals.json
Parameters: id, access_token
Method: PUT
Description: Used to update a goal..
Endpoint: https://api.clevertap.com/1/goals.json
Parameters: id, name, description, type, access_token, expressions, custom_property_mapping
Method: POST
Description: Used to create a new goal..
Endpoint: https://api.clevertap.com/1/goals.json
Parameters: name, description, type, access_token, expressions, custom_property_mapping
Method: DELETE
Description: Used to delete an existing goal..
Endpoint: https://api.clevertap.com/1/goals.json
Parameters: id, access_token
Method: GET
Description: Fetches the details of all the inboxes configured for an app. (Requires a Master Admin Token).
Endpoint: https://api.clevertap.com/1/inboxes.json
Parameters: access_token
Method: GET
Description: Fetches the details of a specific inbox..
Endpoint: https://api.clevertap.com/1/inboxes.json
Parameters: access_token, id
Method: POST
Description: Creates a new inbox..
Endpoint: https://api.clevertap.com/1/inboxes.json
Parameters: access_token, name, description, priority, layout
FAQ
How do I authenticate with the CleverTap API?
To authenticate with the CleverTap API, you will need to use your CleverTap account credentials to generate an API key. This key can then be used to authenticate your requests to the API.
What are the rate limits for the CleverTap API?
The CleverTap API has rate limits in place to prevent abuse of the service. The specific rate limits vary depending on the endpoint being called, but generally speaking, you are limited to a certain number of requests per second or per minute.
How do I create a sandbox account?
To create a sandbox account, you will need to contact CleverTap support. A sandbox account is a separate account that is used for testing purposes and does not affect your live data.
What is the difference between a developer account and a production account?
A developer account is a type of account that is used for development and testing purposes. A production account is a type of account that is used for live data and should not be used for development or testing.
How do I get support for the CleverTap API?
You can get support for the CleverTap API by contacting CleverTap support. Support is available via email, phone, and live chat.