braze-api/cjs/subscription/user/types.d.ts

Track users, send messages, export data, and more with Braze API.

/**
 * Request body for get users’ subscription groups.
 *
 * {@link https://www.braze.com/docs/api/endpoints/subscription_groups/get_list_user_subscription_groups/#request-parameters}
 */
export interface SubscriptionUserStatusObject {
    external_id?: string | string[];
    email?: string | string[];
    phone?: string | string[];
    limit?: number;
    offset?: number;
}
export interface SubscriptionUserStatusResponse {
    users: Array<{
        email: string | null;
        phone: string | null;
        external_id: string | null;
        subscription_groups: Array<{
            id: string;
            name: string;
            channel: string;
            status: 'Subscribed' | 'Unsubscribed';
        }>;
    }>;
    total_count: number;
    message: string;
    errors?: string[];
}
//# sourceMappingURL=types.d.ts.map