Skip to main content
POST
/
v3
/
ratings
Add Rating
curl --request POST \
  --url http://localhost/api/v3/ratings \
  --header 'Content-Type: application/json' \
  --data '
{
  "profile_id": "<string>",
  "source": "product",
  "status": "offered",
  "score_type": "csat1",
  "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
}
'
{
  "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

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