API Reference

Add Notification Enrollment – Creates a notification enrollment for an account.

post
https://example.com/programs//accounts//notification/enrollment

Creates a notification enrollment for an account, enabling notification delivery based on user preferences. Requires account identifier, program code, and enrollment details. Returns enrollment status and details.

Path Params
string
required

The unique code identifying the partner program context for which the notification enrollment is created.

string
required

The unique identifier of the account to enroll for notifications.

Body Params

The Gd.Bos.DataTransfer.Request.CreateNotificationEnrollmentRequest object containing enrollment details, such as notification preferences and contact information.

string | null

The product code for which notifications are being enrolled (e.g., "CARD", "SAVINGS"). Used to scope notification preferences to a specific product or service.

enrollments
array of objects | null

The list of notification enrollment preferences for the account. Each entry specifies the notification type, delivery contacts, enrollment rules, start date, and frequency.

enrollments
Headers
string
required

The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago