Insider APIs
  • 06 Dec 2024
  • 3 Minutes to read

    Insider APIs


      Article summary

      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:

      CategoryAPIFunction
      User DataUpsert user dataSend attributes and events of the users to Insider, insert and update user data
      Export raw user dataHave access to the raw user data and to transfer it to your end
      Delete user attributeDelete your customer attributes
      Delete user's PII data
      Delete users' PII data
      Get user profilesGet the attributes and events you request for your users
      Update identifiersUpdate 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
      GDPRUnsubscribe email users from databaseUnsubscribe 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 usersUpdate your app users' data processing consent to comply with GDPR
      Delete user profileDelete your customers' data
      Message(Email)Send transactional emailsSend targeted eCommerce and personalized one-to-one emails to your users
      Create email campaignsSend email body and subject from your back-end to create email campaigns on Insider platform
      Message (Web Push)Create single web pushesSend 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 PushesSend bulk app pushes to a predefined segment from your own back-end without using Insider's panel
      Send targeted App PushesSend targeted app pushes to a predefined segment from your own back-end without using Insider's panel
      Send advanced App PushesSend 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 APIConnect WhatsApp Bots and send your content
      OTP for WhatsAppGenerate, send, and verify OTP codes for the WhatsApp channel
      AnalyticsGet Web Push analyticsGet the analytics of your web push notifications
      Get App Push analyticsGet the analytics of your single push notifications
      Get Email analyticsGet email campaign list, email campaign analytics, and overall analytics
      Get OnSite analyticsGet the analytics of a campaign

      Get Architect analyticsGet the Architect journeys and elements analytics
      Product CatalogIngest product informationIngest 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
      SearchGet search resultsGet products that match your search criteria and available facet options to further refine the results
      RecommendationsGet recommendationsGet 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?

      ESC

      Eddy AI, facilitating knowledge discovery through conversational intelligence