Omoto CRM API

5min

Introduction
The CRM API offers a standard way to push CRM data from any third party CRM or customer platform into Omoto.
Omoto consumes the customer data sent in each trigger and, after performing basic validation and executing business rules, sends out the relevant survey invite to the customer.
We appreciate that every CRM would have their own API structure, and therefore this document standardises the JSON structure in which Omoto can consume data from any third party CRM.
API Definition
The API is made available on a custom end-point that follows the below structure. The customer contact and qualifying information is sent as JSON payload in the body of the POST request. The JSON structure is also shared below.
Send customer details to Omoto
POST
Params
Body Parameters
key
required
String
API key for the CRM integration provided by Omoto team
﻿
JSON payload to be sent in the POST request body
JSON structure with explanation
﻿
Sample JSON
JS
|
[
  {
    "personalinfo": {
      "firstname": "Bertram",
      "lastname": "Wooster",
      "email": "bertie@jeeves.com",
      "mobileno": "9835132376"
      "transactionid": "202005201623",
      "regid": "TST202005201144"
    },
    "qualifyinginfo": [
      {
        "name": "unitname",
        "value": "Book club"
      },
      {
        "name": "genre",
        "value": "Comedy"
      },
      {
        "name": "author",
        "value": "PG Wodehouse"
      },
      {
        "name": "publisher",
        "value": "Jenkins"
      },
      {
        "name": "country",
        "value": "UK"
      }
    ]
  }
]
[
  {
    "personalinfo": {
      "firstname": "Bertram",
      "lastname": "Wooster",
      "email": "bertie@jeeves.com",
      "mobileno": "9835132376"
      "transactionid": "202005201623",
      "regid": "TST202005201144"
    },
    "qualifyinginfo": [
      {
        "name": "unitname",
        "value": "Book club"
      },
      {
        "name": "genre",
        "value": "Comedy"
      },
      {
        "name": "author",
        "value": "PG Wodehouse"
      },
      {
        "name": "publisher",
        "value": "Jenkins"
      },
      {
        "name": "country",
        "value": "UK"
      }
    ]
  }
]
﻿
Important notes
1. Set content-type to 'application/json'.
2. API keys are used for both authentication and campaign identification. Make sure you use the right API key for the right campaign.
3. Omoto sends out the survey invite immediately after receiving the trigger. Scheduling and timing must be managed your end - trigger when invite has to be sent.
﻿

Updated 03 Mar 2023

Did this page help you?

Freshdesk Integration

Docs powered by

Archbee

CRM API