Skip to main content
PUT /api/v2/notification-preferences Sets the notification opt-ins for the authenticated user. This replaces all existing opt-ins — send the complete set you want enabled, not a delta. To turn everything off, send an empty optIns array.

​
Request

curl
curl -X PUT https://api.interchange.io/api/v2/notification-preferences \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "optIns": [
      { "notificationType": "media_buy.created", "channel": "email" },
      { "notificationType": "media_buy.updated", "channel": "in_app" },
      { "notificationType": "creative.rejected", "channel": "email" }
    ]
  }'

​
Parameters

FieldTypeRequiredNotes
optInsarrayYesThe full set of opt-ins (max 200). Replaces any existing opt-ins
optIns[].notificationTypeenumYesEvent to subscribe to. Values include media_buy.created, media_buy.updated, creative.approved, creative.rejected, salesagent.available, syndication.completed, system.error, and others
optIns[].channelenumYesemail or in_app

​
Response

{
  "optIns": [
    { "notificationType": "media_buy.created", "channel": "email" },
    { "notificationType": "media_buy.updated", "channel": "in_app" },
    { "notificationType": "creative.rejected", "channel": "email" }
  ]
}
The response echoes the opt-ins now in effect.

​
Errors

  • 400 VALIDATION_ERROR — unknown notificationType, invalid channel, or more than 200 opt-ins.
  • 401 UNAUTHORIZED — missing or invalid API key.
See Errors for the full error contract.

Account tasks

All account operations

Get notification preferences

Read current opt-ins

Account overview

Concepts and hierarchy