Rate a chatroom

POST /chat/chatrooms/{chatroom}/ratings

Path parameters

  • chatroom integer Required

    The chatroom id

application/json

Body

  • id_user_rated integer
  • id_user_rater integer

Responses

  • 201 application/json

    Return the created message with rating

    Hide response attributes Show response attributes object
    • id_message integer
    • date_insert string(date-time)
    • author object

      Additional properties are allowed.

      Hide author attributes Show author attributes object
      • id_ambassador integer(int32)
      • image string
      • firstname string
      • lastname string
      • username string
      • email string
      • email_tmp string
      • active integer(int32)
      • status integer(int32)
      • online boolean

        true: when last_action_date is less than 5 minutes ago

      • last_action_date string(date-time)
      • customer_id string
      • anonymized boolean
    • content string
    • type_message integer

      0: text, 1: picture, 2: rating, 3: product, 4: connection, 5: request, 6: unavailable, 7: video, 8: email, 9: missed

    • status_moderation integer
    • rating object

      Only for type_message = 2

      Additional properties are allowed.

      Hide rating attributes Show rating attributes object
      • id_rating integer
      • date_insert string(date-time)
      • date_update string(date-time)
      • date_delete string(date-time)
      • value integer
      • content string
      • id_user_rater integer
      • id_user_rated integer
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
  • 403

    Forbidden - You don't have permission to access this route

  • 422 application/json

    Unprocessable Content

    Hide response attributes Show response attributes object
    • message string

      Error message.

    • errors object
      Hide errors attributes Show errors attributes object
      • field array[string]

        Error message details.

      • * array[string] Additional properties

        Error message details.

POST /chat/chatrooms/{chatroom}/ratings
curl \
 --request POST 'https://domain.tld/api/v2/chat/chatrooms/{chatroom}/ratings' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"id_user_rated":5,"id_user_rater":2}'
Request examples
{
  "id_user_rated": 5,
  "id_user_rater": 2
}
Response examples (201)
{
  "id_message": 16,
  "date_insert": "2023-10-09T12:12:40.220000Z",
  "author": {
    "id_ambassador": 42,
    "image": "string",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "email": "string",
    "email_tmp": "string",
    "active": 42,
    "status": 42,
    "online": true,
    "last_action_date": "2025-05-04T09:42:00Z",
    "customer_id": "string",
    "anonymized": true
  },
  "content": "super",
  "type_message": 2,
  "status_moderation": 0,
  "rating": {
    "id_rating": 1,
    "date_insert": "2023-10-09T12:12:40.220000Z",
    "date_update": "2023-10-09T12:12:40.220000Z",
    "date_delete": "2023-10-09T12:12:40.220000Z",
    "value": 5,
    "content": "bien",
    "id_user_rater": 1,
    "id_user_rated": 2
  }
}
Response examples (401)
{
  "message": "Unauthorized."
}
Response examples (422)
{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}