POST/api/v2/referrals/programs/{programId}/drafts/{draftId}/change-preview

POST /api/v2/referrals/programs/{programId}/drafts/{draftId}/change-preview

Authentication

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

Parameters

Request parameters
FieldTypeRequiredDescription
programId (path)string (uuid)Yes
draftId (path)string (uuid)Yes

Request body

application/json

Request body fields
FieldTypeRequiredDescription
DraftRevisionunknownNo
EffectiveAtstring (date-time)No

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
DraftIdstring (uuid)Yes
DraftRevisionunknownYes
HashstringYes
ExpiresAtstring (date-time)Yes
EffectiveAtstring (date-time)Yes
ExistingQualifiedunknownYes
ExistingUnqualifiedunknownYes
CohortstringYes
ChangedFieldsarray of stringYes
TermsAcceptanceRequiredbooleanYes
Warningsarray of stringYes

Example request

curl -X POST "https://{base_url}/api/v2/referrals/programs/{programId}/drafts/{draftId}/change-preview" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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