With Insider's APIs, you can perform actions such as creating, reading, updating, and deleting data on Insider's platform. These APIs enable you to send messages to users, update user profiles, export statistics, and more—directly from your systems.
This guide provides an overview of Insider's API capabilities, authentication requirements, and general usage principles.
Scope
Using Insider's APIs, you can perform many actions based on your use cases. For example, you can create and send Web Push notifications to your opt-in users or unify your users' online data with their offline purchase data. See below for the available actions:
| Category | API | Endpoint | Function |
|---|---|---|---|
| User Data | Upsert user data | https://unification.useinsider.com/api/user/v1/upsert | Send attributes and events of the users to Insider, insert and update user data |
| Export raw user data | https://unification.useinsider.com/api/raw/v1/export | Have access to the raw user data and to transfer it to your end | |
| Delete user attribute | https://unification.useinsider.com/api/user/v1/attribute/delete | Delete your customer attributes | |
| Get user profiles | https://unification.useinsider.com/api/user/v1/profile | Get the attributes and events you request for your users | |
| Update identifiers | https://unification.useinsider.com/api/user/v1/identity | Update the value of the identifiers that are already associated with users | |
| Delete identifiers | https://unification.useinsider.com/api/user/v1/identity | Delete the value of the identifiers that are already associated with users | |
| Upload custom segments to mobile suite | https://mobile.useinsider.com/api/custom_segment/v1/upload | Upload custom segments via a CSV file to your Insider Mobile Suite | |
| Upload first-party segments | https://contact.useinsider.com/fps/v1/upload | Create a first-party segment | |
| Data Governance | Unsubscribe email users from database | https://contact.useinsider.com/email/v1/unsubscribe | Unsubscribe email subscribers from the email platform |
| Unsubscribe email users from database / v2 | https://contact.useinsider.com/email/v2/unsubscribe | Ingest email addresses under global unsubscribe or ingest email addresses under the unsubscribe group | |
| Unsubscribe SMS users from database | https://contact.useinsider.com/sms/v1/unsubscribe | Unsubscribe users from Insider's SMS platform | |
| Unsubscribe SMS users from database / v2 | https://contact.useinsider.com/sms/v2/unsubscribe | Unsubscribe users from Insider's SMS platform with support for bulk data ingestion. | |
| Unsubscribe WhatsApp users from database | https://contact.useinsider.com/whatsapp/v1/unsubscribe | Unsubscribe users from Insider's WhatsApp platform | |
| Unsubscribe WhatsApp users from database / v2 | https://contact.useinsider.com/whatsapp/v2/unsubscribe | Unsubscribe users from Insider's WhatsApp platform with support for bulk data ingestion. | |
| Resubscribe email users | https://contact.useinsider.com/email/v1/subscribe | Set an unreachable email status as reachable on Insider's email platform | |
| Resubscribe email users / v2 | https://contact.useinsider.com/email/v2/subscribe | Set an unreachable email status as reachable on Insider's email platform at the group level | |
| Resubscribe SMS users | https://contact.useinsider.com/sms/v1/subscribe | Set an unreachable phone number status as reachable on Insider's SMS platform | |
| Resubscribe SMS users / v2 | https://contact.useinsider.com/sms/v2/subscribe | Set an unreachable phone number status as reachable on Insider's SMS platform with support for bulk data ingestion | |
| Resubscribe WhatsApp users | https://contact.useinsider.com/whatsapp/v1/subscribe | Set an unreachable phone number status as reachable on Insider's WhatsApp platform | |
| Resubscribe WhatsApp users / v2 | https://contact.useinsider.com/whatsapp/v2/subscribe | Set an unreachable phone number status as reachable on Insider's WhatsApp platform with support for bulk data ingestion | |
| Set data processing consent for App users | https://mobile.useinsider.com/api/v1/privacy/gdpr/consent/set | Update your app users' data processing consent to comply with GDPR | |
| Delete user profile | https://unification.useinsider.com/api/user/v1/delete | Delete your customers' data | |
| Delete user's PII data | https://unification.useinsider.com/api/contact/v1/anonymize https://unification.useinsider.com/api/user/v1/anonymize | Delete users' PII data | |
| Message(Email) | Send transactional emails | https://mail.useinsider.com/mail/v1/send | Send targeted eCommerce and personalized one-to-one emails to your users |
| Create email campaigns | https://mail.useinsider.com/content/v1/campaign/create | Send email body and subject from your back-end to create email campaigns on the Insider One's InOne panel | |
| Message (Web Push) | Create single web pushes | https://web-push.api.useinsider.com/v1/single | Send single web push notifications from your own back-end without using Insider One's InOne panel |
| Launch single web pushes | https://web-push.api.useinsider.com/v1/single/campaign_id | Launch single web push notifications from your own back-end without using Insider One's InOne panel | |
| Launch single web pushes | https://web-push.api.useinsider.com/v2/single/campaign_id | Launch single web push notifications from your own back-end without using Insider One's InOne panel | |
| Delete single web pushes | https://web-push.api.useinsider.com/v1/single/campaign_id | Delete single web push notifications from your own back-end without using Insider One's InOne panel | |
| Message (App Push) | Send bulk App Pushes | https://mobile.useinsider.com/api/v1/push/bulk | Send bulk app pushes to a predefined segment from your own back-end without using Insider's panel |
| Send targeted App Pushes | https://mobile.useinsider.com/api/v2/notification/user | Send targeted app pushes to a predefined segment from your own back-end without using Insider's panel | |
| Send advanced App Pushes | https://mobile.useinsider.com/api/v2/notification/user | Send advanced app pushes to a predefined segment from your own back-end without using Insider's panel | |
| Get pushes with Message Center API | https://mobile.useinsider.com/api/message_center/v1 | Get push notifications of any type delivered to your users during a defined time interval | |
| Get InApp details | https://mobile.api.useinsider.com/v1/details/inapp | Retrieve detailed information about your app template campaigns | |
| Upload FCM certificate | https://mobile.api.useinsider.com/v1/settings/certificate/firebase | Upload your FCM certificate to Insider without visiting the InOne panel | |
| Message (SMS) | Send transactional SMS | https://sms.useinsider.com/v1/send | Send targeted transactional SMS to your users |
| Send Transactional Bulk SMS | https://sms.useinsider.com/v1/sendMultipleMessage | Send targeted transactional SMS to your users in bulk | |
| OTP for SMS | https://verify.useinsider.com/v1/channel | Generate, send, and verify OTP codes for the SMS channel | |
| Message (WhatsApp) | WhatsApp Transactional API | https://whatsapp.useinsider.com/v1/send | Create your WhatsApp message template and send your content |
| Conversational API | https://whatsapp.useinsider.com/v1/conversational/send | Connect WhatsApp Bots and send your content | |
| OTP for WhatsApp | https://verify.useinsider.com/v1/channel | Generate, send, and verify OTP codes for the WhatsApp channel | |
| Analytics | Get Web Push analytics | https://web-push.api.useinsider.com/v1/statistics | Get the analytics of your web push notifications |
| Get App Push analytics | https://mobile.useinsider.com/api/v1/notification/get_statistics https://unification.useinsider.com/api/raw/v1/export | Get the analytics of your single push notifications | |
| Get Email analytics | https://analytics.api.useinsider.com/email/v1/campaign https://analytics.api.useinsider.com/email/v2/campaign | Get email campaign list, email campaign analytics, and overall analytics | |
| Get SMS analytics | https://sms.useinsider.com/analytics/v1 | Get the analytics of your SMS analytics | |
| Get OnSite analytics | https://analytics.api.useinsider.com/onsite/v1 | Get the analytics of a campaign | |
| Get Architect analytics | https://architect-analytics.api.useinsider.com/v1 | Get the Architect journeys and elements analytics | |
| Product Catalog | Ingest product information | https://catalog.api.useinsider.com/v2/ingest | Ingest product data into your feed to overcome the latency on product-related field updates |
| Update existing product information | https://catalog.api.useinsider.com/v2/update | Update the existing products in your Product Catalog | |
| Search | Get search results | https://ineureka.api.useinsider.com/api/web/search | Get products that match your search criteria and available facet options to refine the results further |
| Get search recommendations | https://{domain_name}/api/web/suggestions/query | Get query recommendations as users type into a search bar | |
| Manage product listing pages | https://ineureka.api.useinsider.com/api/web/collections/{type}?cf={COLLECTION_FILTER}&p={PARTNER_ID}&l={LOCALE}&c={CURRENCY} | Get precise curation and manage product listing pages | |
| Get user interactions | https://eurekaevent.api.useinsider.com/api/v1/events | Get user interactions, including search queries, clicks, add-to-cart actions, and purchases |
Authentication Requirements
To send a request, you might need the following requirements, depending on the API you are using:
API key
Insider uses authentication to validate and process incoming API calls. Each API request must include an API key—a unique code used to authenticate the request and authorize access.
Only users with Administrator permissions can generate API tokens. If your account does not have the necessary permissions, please contact the Insider One team for assistance.
Your title goes here
For security reasons, generated tokens are fully visible only once—immediately after they are created. After that, the full token will no longer be accessible.
We strongly recommend saving the token securely at the time of generation. If needed, you can always generate a new token for your project.
We strongly recommend saving the token securely at the time of generation. If needed, you can always generate a new token for your project.
Read more about API Authentication Tokens.
Request (Partner) Token
Some of the Insider APIs listed above might require a request token. The Insider One team provides this token for your account.
Partner Name
Some of the Insider APIs listed above might require your partner name. Your partner name is displayed in the dropdown menu next to your user name on your dashboard.
You can also navigate to InOne > Inone Settings > Account Settings to read your partner name. 
Rate Limits
Rate limiting controls the number of API requests that can be made within a defined time window. In large systems, many unintentional denial-of-service (DoS) incidents stem from software bugs or configuration errors rather than malicious attacks. By enforcing rate limits, the system protects itself from overload and ensures stable performance.
If you exceed the allowed number of requests in the given timeframe, the API will respond with an error, typically a 429 Too Many Requests status code.
Refer to the API Rate Limits for the specific rate limits applied to Insider APIs.