Skip to main content
GET /api/v2/notification-preferences Returns the notification opt-ins for the authenticated user. Each opt-in pairs a notificationType with a delivery channel.

Request

curl
curl https://api.interchange.io/api/v2/notification-preferences \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

None. Preferences are scoped to the authenticated user.

Response

{
  "optIns": [
    { "notificationType": "media_buy.created", "channel": "email" },
    { "notificationType": "creative.rejected", "channel": "in_app" }
  ]
}
FieldTypeNotes
optIns[]arrayOne entry per enabled notification
optIns[].notificationTypestringThe event the user is opted into (e.g. media_buy.created, creative.rejected)
optIns[].channelenumemail or in_app

Errors

  • 401 UNAUTHORIZED — missing or invalid API key.
See Errors for the full error contract.

Account tasks

All account operations

Update notification preferences

Replace your opt-ins

Account overview

Concepts and hierarchy