braze-api/cjs/users/export/segment.d.ts

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

import type { UsersExportSegmentObject, UsersExportSegmentResponse } from './types';
/**
 * Users by segment endpoint.
 *
 * This endpoint allows you to export all the users within a segment.
 *
 * {@link https://www.braze.com/docs/api/endpoints/export/user_data/post_users_segment/}
 *
 * @param apiUrl - Braze REST endpoint.
 * @param apiKey - Braze API key.
 * @param body - Request parameters.
 * @returns - Braze response.
 */
export declare function segment(apiUrl: string, apiKey: string, body: UsersExportSegmentObject): Promise<UsersExportSegmentResponse>;
//# sourceMappingURL=segment.d.ts.map