Insider APIs
- 06 Dec 2024
- 3 Minutes to read
Insider APIs
- Updated on 06 Dec 2024
- 3 Minutes to read
Article summary
Did you find this summary helpful?
Thank you for your feedback
Insider's REST APIs provide you the ability to insert and update user data, manage web pushes, or inform you about updated product information. Insider also provides Webhooks that are used to manage email capabilities. To know what is the difference between an API and a Webhook, read our article Webhook vs API.
Insider provides APIs that you can call from your end to create, delete, update, and read data on Insider's end. Using these APIs, you can send messages to your users, update their data, export your statistics, and perform many other actions on your end.
This guide covers the scope of Insider APIs, their authentication requirements, and an overview of an API.
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 | Function |
|---|---|---|
| User Data | Upsert user data | Send attributes and events of the users to Insider, insert and update user data |
| Export raw user data | Have access to the raw user data and to transfer it to your end | |
| Delete user attribute | Delete your customer attributes | |
| Delete user's PII data | Delete users' PII data | |
| Get user profiles | Get the attributes and events you request for your users | |
| Update identifiers | Update the value of the identifiers that are already associated with users | |
| Delete identifiers | Delete the value of the identifiers that are already associated with users | |
| Upload custom segments to mobile suite | Upload custom segments via a CSV file to your Insider Mobile Suite | |
| Upload first-party segments | Create a first-party segment | |
| GDPR | Unsubscribe email users from database | Unsubscribe email subscribers from the email platform |
| Unsubscribe email users from database | Ingest email addresses under global unsubscribe or ingest email addresses under the unsubscribe group | |
| Unsubscribe SMS users from database | Unsubscribe users from Insider's SMS platform | |
| Unsubscribe WhatsApp users from database | Unsubscribe users from Insider's WhatsApp platform | |
| Resubscribe email users | Set an unreachable email status as reachable on Insider's email platform | |
| Resubscribe email users | Set an unreachable email status as reachable on Insider's email platform at the group level | |
| Resubscribe SMS users | set an unreachable phone number status as reachable on Insider's SMS platform | |
| Resubscribe WhatsApp users | Set an unreachable phone number status as reachable on Insider's WhatsApp platform | |
| Set data processing consent for App users | Update your app users' data processing consent to comply with GDPR | |
| Delete user profile | Delete your customers' data | |
| Message(Email) | Send transactional emails | Send targeted eCommerce and personalized one-to-one emails to your users |
| Create email campaigns | Send email body and subject from your back-end to create email campaigns on Insider platform | |
| Message (Web Push) | Create single web pushes | Send single web push notifications from your own back-end without using Insider's InOne panel |
| Delete single web pushes | Delete single web push notifications from your own back-end without using Insider's InOne panel | |
| Launch single web pushes | Launch single web push notifications from your own back-end without using Insider's InOne panel | |
| Message (App Push) | Send bulk App Pushes | Send bulk app pushes to a predefined segment from your own back-end without using Insider's panel |
| Send targeted App Pushes | Send targeted app pushes to a predefined segment from your own back-end without using Insider's panel | |
| Send advanced App Pushes | Send advanced app pushes to a predefined segment from your own back-end without using Insider's panel | |
| Get pushes with Message Center API | Get push notifications of any type delivered to your users during a defined time interval | |
| Message (SMS) | Send transactional SMS | Send targeted transactional SMS to your users |
| OTP for SMS | Generate, send, and verify OTP codes for the SMS channel | |
| Message (WhatsApp) | WhatsApp Transactional API | Create your WhatsApp message template and send your content |
| Conversational API | Connect WhatsApp Bots and send your content | |
| OTP for WhatsApp | Generate, send, and verify OTP codes for the WhatsApp channel | |
| Analytics | Get Web Push analytics | Get the analytics of your web push notifications |
| Get App Push analytics | Get the analytics of your single push notifications | |
| Get Email analytics | Get email campaign list, email campaign analytics, and overall analytics | |
| Get OnSite analytics | Get the analytics of a campaign | |
| Get Architect analytics | Get the Architect journeys and elements analytics | |
| Product Catalog | Ingest product information | Ingest product data to your feed to overcome the latency on product-related field updates |
| Update existing product information | Update the existing products in your Product Catalog | |
| Search | Get search results | Get products that match your search criteria and available facet options to further refine the results |
| Recommendations | Get recommendations | Get recommendations based on different algorithms and parameters |
Authentication Requirements
To send a request, you might need the following requirements depending on the API you are using:
- API key
- Request (partner) token
- Partner name
API key
An API key helps you authenticate your API call. Read more about API Authentication Tokens.
Request (Partner) Token
Some of the Insider APIs listed above might require a request token. The Insider team provides this token for your account.
Partner Name
Some of the Insider APIs listed above might require your partner name. You can see your partner name on the dropdown next to your user name on your dashboard.
You can also navigate to InOne > Inone Settings > Account Preferences to read your partner name. 
Was this article helpful?