Skip to main content
POST
/
v3
/
ratings
Add Rating
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/ratings \
  --header 'Content-Type: application/json' \
  --data '
{
  "profile_id": "<string>",
  "score": 123,
  "requires_action": true,
  "product_id": 123,
  "staff_id": "<string>",
  "product_variant_id": 123,
  "transaction_id": 123,
  "interaction_id": 123,
  "external_id": "<string>",
  "namespace": "<string>",
  "title": "<string>",
  "comment": "<string>",
  "reason": "<string>",
  "meta": [
    "<string>"
  ],
  "is_public": true,
  "is_active": true
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/ratings"

payload = {
"profile_id": "<string>",
"score": 123,
"requires_action": True,
"product_id": 123,
"staff_id": "<string>",
"product_variant_id": 123,
"transaction_id": 123,
"interaction_id": 123,
"external_id": "<string>",
"namespace": "<string>",
"title": "<string>",
"comment": "<string>",
"reason": "<string>",
"meta": ["<string>"],
"is_public": True,
"is_active": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
profile_id: '<string>',
score: 123,
requires_action: true,
product_id: 123,
staff_id: '<string>',
product_variant_id: 123,
transaction_id: 123,
interaction_id: 123,
external_id: '<string>',
namespace: '<string>',
title: '<string>',
comment: '<string>',
reason: '<string>',
meta: ['<string>'],
is_public: true,
is_active: true
})
};

fetch('https://api.{tenant}.getomneo.com/api/v3/ratings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/ratings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'profile_id' => '<string>',
'score' => 123,
'requires_action' => true,
'product_id' => 123,
'staff_id' => '<string>',
'product_variant_id' => 123,
'transaction_id' => 123,
'interaction_id' => 123,
'external_id' => '<string>',
'namespace' => '<string>',
'title' => '<string>',
'comment' => '<string>',
'reason' => '<string>',
'meta' => [
'<string>'
],
'is_public' => true,
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.{tenant}.getomneo.com/api/v3/ratings"

payload := strings.NewReader("{\n \"profile_id\": \"<string>\",\n \"score\": 123,\n \"requires_action\": true,\n \"product_id\": 123,\n \"staff_id\": \"<string>\",\n \"product_variant_id\": 123,\n \"transaction_id\": 123,\n \"interaction_id\": 123,\n \"external_id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"title\": \"<string>\",\n \"comment\": \"<string>\",\n \"reason\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"is_public\": true,\n \"is_active\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/ratings")
.header("Content-Type", "application/json")
.body("{\n \"profile_id\": \"<string>\",\n \"score\": 123,\n \"requires_action\": true,\n \"product_id\": 123,\n \"staff_id\": \"<string>\",\n \"product_variant_id\": 123,\n \"transaction_id\": 123,\n \"interaction_id\": 123,\n \"external_id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"title\": \"<string>\",\n \"comment\": \"<string>\",\n \"reason\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"is_public\": true,\n \"is_active\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/ratings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_id\": \"<string>\",\n \"score\": 123,\n \"requires_action\": true,\n \"product_id\": 123,\n \"staff_id\": \"<string>\",\n \"product_variant_id\": 123,\n \"transaction_id\": 123,\n \"interaction_id\": 123,\n \"external_id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"title\": \"<string>\",\n \"comment\": \"<string>\",\n \"reason\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"is_public\": true,\n \"is_active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": 123,
    "profile_id": "<string>",
    "source": "<string>",
    "product_id": 123,
    "product_variant_id": 123,
    "transaction_id": 123,
    "interaction_id": 123,
    "staff_id": "<string>",
    "external_id": "<string>",
    "status": "<string>",
    "score_type": "<string>",
    "score": 123,
    "namespace": "<string>",
    "title": "<string>",
    "comment": "<string>",
    "reason": "<string>",
    "is_public": true,
    "is_active": true,
    "requires_action": true,
    "meta": [
      "<unknown>"
    ],
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>",
"errors": {}
}

Body

application/json
profile_id
string
required
source
enum<string>
required
Available options:
product,
product_variant,
transaction,
staff,
interaction,
external
status
enum<string>
required
Available options:
offered,
declined,
received
score_type
enum<string>
required
Available options:
csat1,
csat2,
csat3,
csat4,
csat5,
csat6,
csat7,
csat8,
csat9,
csat10,
nps
score
integer
required
requires_action
boolean
required
product_id
integer
staff_id
string
product_variant_id
integer
transaction_id
integer
interaction_id
integer
external_id
string
namespace
string | null
title
string | null
comment
string | null
reason
string | null
meta
string[] | null
is_public
boolean | null
is_active
boolean | null

Response

Rating

data
Rating · object
required