Skip to main content
POST
Error

Headers

x-api-key
string
required
Pattern: ^abl_

Path Parameters

projectId
string
required

Body

application/json
survey
string
required

The survey this rating answers, by name.

rating
number
required

The value given, on the survey control's own scale. Validated against the resolved survey's range and rejected (422 INVALID_INPUT) when out of range — never clamped.

session_id
string

The conversation this rating belongs to, if the caller knows it.

comment
string

Open-text comment. Optional; readable by any caller holding the read scope.

Maximum string length: 4000
externalUserId
string

The caller's own identifier for the respondent. Never used for scoring.

channel
string

The caller's own channel label for this response.

response_source
string
default:external

How the caller categorises the capture source. Stored as given so a partner can distinguish its own sub-sources. It does not change origin (resolved from the credential) or the score.

message_id
string

The caller's own message or turn identifier, stored for correlation.

Response

The rating was recorded.

success
boolean
required
data
object
required