Omoto Response API

2min

Introduction
Client can initiate a request to push campaign response to Omoto. 
The Push would be sent by the Client in a JSON format that is standardised for receiving campaign responses. This format must be as per the below provided JSON.
We would provide an endpoint with apikey where the client can push the data. This must be pushed one at a time. Endpoint would be provided after the verification of the JSON prepared by the Client.
This API endpoint allows clients to push campaign response to Omoto
POST
Request
Form Parameters
jsonheader
required
String
{"processid":"76"}
jsonbody
required
String
{"campaignid":"{{campaignid}}","channel":"{{channel}}","campaigntype":"{{campaigntype}}","catnpsmap":{"{{catnpsmap1}}":[],"{{catnpsmap2}}":[]},"npsrating":"{{npsrating}}","comment":"{{comment}}","customerinfo":{"email":"{{email}}","regid":"{{regid}}","registrationno":"{{registrationno}}","mobileno":"{{mobileno}}","name":"{{name}}"},"namevaluemap":{"unitname":"{{unitname}}"}}
﻿
JSON Attribute Description
Attribute name
Description
campaignid
Unique id of campaign, this will be provided by Omoto team and it must always match the id sent by Omoto. 
comment
Any free comment from the Customer.
unitname
Name of the Unit, as given by Omoto
namevaluemap
This contains all Customer specific qualifying information. It is sent in the form of name value pairs. The names are specific and pre-defined so that they can be identified as such at Omoto end.
npsrating
Overall NPS rating, in case it is a NPS questionnaire (or a CSAT survey with a NPS element).
catnpsmap
Categories selected by the customer at the time of survey is sent here.
﻿

Attribute name	Description
campaignid	Unique id of campaign, this will be provided by Omoto team and it must always match the id sent by Omoto.
comment	Any free comment from the Customer.
unitname	Name of the Unit, as given by Omoto
namevaluemap	This contains all Customer specific qualifying information. It is sent in the form of name value pairs. The names are specific and pre-defined so that they can be identified as such at Omoto end.
npsrating	Overall NPS rating, in case it is a NPS questionnaire (or a CSAT survey with a NPS element).
catnpsmap	Categories selected by the customer at the time of survey is sent here.

Updated 25 Mar 2024

Did this page help you?

Freshdesk Integration