PUT
/api/v2/referrals/alert-settingsPUT /api/v2/referrals/alert-settings
Authentication
Send your API key in the x-api-key header on every request.
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| Enabled | boolean | No | |
| EmailRecipients | array of string | No | |
| SlackWebhookSecretReference | string | No | Deployment-managed alias, never a webhook URL or token. Null removes Slack delivery. |
| ExposureThresholdPercent | unknown | No | |
| ExposureRecoveryPercent | unknown | No | |
| StaleCreditMinutes | unknown | No | |
| SampleWindowMinutes | unknown | No | |
| MinimumSampleSize | unknown | No | |
| CreditFailureThresholdPercent | unknown | No | |
| ExcludedEventThresholdPercent | unknown | No | |
| CooldownMinutes | unknown | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Settings | ReferralAlertSettingsRequest | Yes | |
| SlackWebhookConfigured | boolean | Yes | |
| UpdatedAt | string (date-time) | Yes | |
| UpdatedByUserId | unknown | Yes | |
| WorkerEnabled | boolean | No |
Example request
curl -X PUT "https://{base_url}/api/v2/referrals/alert-settings" \
-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.