PUT/api/v2/referrals/programs/{programId}/geo-policy

PUT /api/v2/referrals/programs/{programId}/geo-policy

Authentication

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

Parameters

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

Request body

application/json

Request body fields
FieldTypeRequiredDescription
ExpectedRevisionunknownYes
EnabledbooleanYes
AllowedCountryCodesarray of stringYes
PendingExpiryDaysunknownYes
DefaultLocalestringYes
TermsVersionunknownYes
TermsByLocaleobjectYes
ExcludedCountryCodesarray of stringNo
CountryBasisstringNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
VersionIdstring (uuid)Yes
RevisionunknownYes
EnabledbooleanYes
AllowedCountryCodesarray of stringYes
PendingExpiryDaysunknownYes
DefaultLocalestringYes
TermsVersionunknownYes
TermsByLocaleobjectYes
ExcludedCountryCodesarray of stringNo
CountryBasisstringNo
PendingDeadlineBasisstringNo
PendingDeadlineExplanationstringNo

Example request

curl -X PUT "https://{base_url}/api/v2/referrals/programs/{programId}/geo-policy" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ExpectedRevision":"…","Enabled":"…","AllowedCountryCodes":"…","PendingExpiryDays":"…"}'

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