Omoto CRM API
4 min
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 tab request url https domain omoto io omoto receivecustomerinfo htm?key apikey name crm api method post request pathparameters queryparameters headerparameters bodydataparameters kind required name key type string description api key for the crm integration provided by omoto team formdataparameters results languages id olomtky t1vhm9bs81gdc code n status success n language 200 id mc5yhpqsebuapfsjpig6s code n response keymismatch n language 401 selectedlanguageid olomtky t1vhm9bs81gdc examples languages id spovx6jdmlnz9owklywga code n n personalinfo n firstname bertram n lastname wooster n email bertie jeeves com n mobileno 9835132376 n transactionid 202005201623 n regid tst202005201144 n n qualifyinginfo n n name unitname n value book club n n n name genre n value comedy n n n name author n value pg wodehouse n n n name publisher n value jenkins n n n name country n value uk n n n n language json selectedlanguageid spovx6jdmlnz9owklywga description send customer details to omoto currentnewparameter label body parameter value bodydataparameters json payload to be sent in the post request body sample json \[ { "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