H!HOPPA
POST/api/v2/referrals/reviews/{reviewId}/decisions

POST /api/v2/referrals/reviews/{reviewId}/decisions

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
reviewId (path)string (uuid)Yes

Request body

application/json

Request body fields
FieldTypeRequiredDescription
DecisionstringYes
ReasonstringYes
ExpectedRevisionunknownYes
IdempotencyKeystringYes

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
ProgramIdstring (uuid)Yes
RelationshipIdstring (uuid)Yes
InviterUserIdunknownYes
FriendUserIdunknownYes
StatusstringYes
RevisionunknownYes
CreatedAtstring (date-time)Yes
UpdatedAtstring (date-time)Yes
Signalsarray of ReferralRiskSignalResponseYes

Example request

curl -X POST "https://{base_url}/api/v2/referrals/reviews/{reviewId}/decisions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Decision":"…","Reason":"…","ExpectedRevision":"…","IdempotencyKey":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.