Meeting ratings

Create and update meeting ratings with complete curl request examples.

Build a request

Example data only. No request is sent.

POST

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request POST \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/meeting-ratings' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "simple_rateable_id": 6001,
  "registrant_id": 1201,
  "score": 5
}'

201 CreatedIllustrative response

Write-response fields

{
  "data": {
    "id": "1201",
    "type": "meeting-rating"
  }
}

The token scope determines returned fields. This selector illustrates that configuration; it does not change your token or the request.

Collection path: events/{event_id}/meeting-ratings

POST a meeting rating

POST is an upsert for the meeting and registrant pair. Repeating the request updates the existing rating rather than creating a duplicate.

View the complete cURL example

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request POST \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/meeting-ratings' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "simple_rateable_id": 6001,
  "registrant_id": 1201,
  "score": 5,
  "comment": "A useful conversation"
}'

The response type is meeting-rating. Useful write-response fields include simple_rateable_id (returned as meeting-id), registrant_id, score, comment, and skipped.

PATCH a meeting rating

View the complete cURL example

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request PATCH \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/meeting-ratings/8801' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "score": 4,
  "comment": "Useful follow-up"
}'

Do not send simple_rateable_id or registrant_id on PATCH. Unlike an unselected parameter, a selected and supplied identity field is explicitly rejected by this mutation.

Input reference

4 inputs. Expand a field for its request type and update behavior. These are the example request keys; your administrator can configure aliases.

simple_rateable_idScalar ID

POST: Required for a successful create
PATCH: Rejected if supplied

Meeting must belong to the event and be accepted.

registrant_idScalar ID

POST: Required for a successful create
PATCH: Rejected if supplied

Registrant must belong to the event, have a Brella user, and participate in the meeting.

scoreInteger

POST: Required by the model
PATCH: Optional

0 represents skipped; accepted range is 0 to 50.

commentScalar string or `null`

POST: Optional
PATCH: Optional

Rating comment.