# Reference ## Account

client.account.getAccount() -> Brevo.GetAccountResponse

#### 📝 Description

Retrieves details of your Brevo account. **Use this to:** - Get account information (email, name, company, address) - Check plan details (type, credits, expiration) - Get relay information (for transactional emails) - Check Marketing Automation status - Access organization and user identifiers **Key information returned:** - Complete account details (organization ID, user ID, company information) - Address and contact information - Plan configurations and credit allocations across different verticals - Marketing Automation settings and tracker key (when enabled) - SMTP relay configuration for transactional emails - Enterprise features availability status **Important considerations:** - Provides comprehensive account overview for billing and configuration management - Essential for understanding current plan limitations and feature availability - Marketing Automation key is only returned when Marketing Automation is enabled on the account - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories (only returned when plan verticals are available) - Relay configuration crucial for transactional email setup and deliverability - Enterprise status determines access to advanced features and sub-account management

#### 🔌 Usage

```typescript await client.account.getAccount(); ```

#### ⚙️ Parameters

**requestOptions:** `AccountClient.RequestOptions`

client.account.getAccountActivity({ ...params }) -> Brevo.GetAccountActivityResponse

#### 📝 Description

Retrieves user activity logs from your organization for security monitoring and audit compliance. Use this to: - Monitor user login activities and access patterns - Track account modifications and configuration changes - Generate security audit reports and compliance documentation - Investigate suspicious activities and unauthorized access - Monitor team member actions and account usage Key information returned: - Complete user activity details and timestamps - User identification (email, IP address, browser) - Action types and activity descriptions - Security-relevant events and access logs - Historical activity data for audit trails Note: Requires Enterprise plan for access to organization activity logs.

#### 🔌 Usage

```typescript await client.account.getAccountActivity(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetAccountActivityRequest`

**requestOptions:** `AccountClient.RequestOptions`

## MasterAccount

client.masterAccount.createANewGroupOfSubAccounts({ ...params }) -> Brevo.PostCorporateGroupResponse

#### 📝 Description

This endpoint allows to create a group of sub-accounts

#### 🔌 Usage

```typescript await client.masterAccount.createANewGroupOfSubAccounts({ groupName: "My group" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCorporateGroupRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.deleteSubAccountFromGroup({ ...params }) -> void

#### 📝 Description

This endpoint allows you to remove a sub-organization from a group.

#### 🔌 Usage

```typescript await client.masterAccount.deleteSubAccountFromGroup({ groupId: "groupId", subAccountIds: [423432, 234323, 87678] }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateGroupUnlinkGroupIdSubAccountsRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.getAGroupDetails({ ...params }) -> Brevo.GetCorporateGroupIdResponse

#### 📝 Description

This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.

#### 🔌 Usage

```typescript await client.masterAccount.getAGroupDetails({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCorporateGroupIdRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.updateAGroupOfSubAccounts({ ...params }) -> void

#### 📝 Description

This endpoint allows to update a group of sub-accounts

#### 🔌 Usage

```typescript await client.masterAccount.updateAGroupOfSubAccounts({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateGroupIdRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.deleteAGroup({ ...params }) -> void

#### 📝 Description

This endpoint allows you to delete a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group. The users associated with the group are no longer associated with the group once deleted.

#### 🔌 Usage

```typescript await client.masterAccount.deleteAGroup({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCorporateGroupIdRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.getSubAccountGroups() -> Brevo.GetSubAccountGroupsResponseItem[]

#### 📝 Description

This endpoint allows you to list all groups created on your Admin account.

#### 🔌 Usage

```typescript await client.masterAccount.getSubAccountGroups(); ```

#### ⚙️ Parameters

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.getCorporateInvitedUsersList({ ...params }) -> Brevo.GetCorporateInvitedUsersListResponse

#### 📝 Description

This endpoint allows you to list all Admin users of your Admin account. You can filter users by type (active or pending) and paginate results using offset and limit.

#### 🔌 Usage

```typescript await client.masterAccount.getCorporateInvitedUsersList(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCorporateInvitedUsersListRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.listOfAllIPs() -> Brevo.GetCorporateIpResponseItem[]

#### 📝 Description

This endpoint allows you to retrieve the list of active IPs on your Admin account

#### 🔌 Usage

```typescript await client.masterAccount.listOfAllIPs(); ```

#### ⚙️ Parameters

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.getTheDetailsOfRequestedMasterAccount() -> Brevo.GetCorporateMasterAccountResponse

#### 📝 Description

This endpoint will provide the details of the master account.

#### 🔌 Usage

```typescript await client.masterAccount.getTheDetailsOfRequestedMasterAccount(); ```

#### ⚙️ Parameters

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.generateSsoTokenToAccessAdminAccount({ ...params }) -> Brevo.GetSsoToken

#### 📝 Description

This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.

#### 🔌 Usage

```typescript await client.masterAccount.generateSsoTokenToAccessAdminAccount({ email: "vipin+ent-user@brevo.com" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCorporateSsoTokenRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.getTheListOfAllTheSubAccountsOfTheMasterAccount({ ...params }) -> Brevo.GetCorporateSubAccountResponse

#### 📝 Description

This endpoint will provide the list all the sub-accounts of the master account.

#### 🔌 Usage

```typescript await client.masterAccount.getTheListOfAllTheSubAccountsOfTheMasterAccount({ offset: 1, limit: 1 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCorporateSubAccountRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.createANewSubAccountUnderAMasterAccount({ ...params }) -> Brevo.PostCorporateSubAccountResponse

#### 📝 Description

This endpoint will create a new sub-account under a master account

#### 🔌 Usage

```typescript await client.masterAccount.createANewSubAccountUnderAMasterAccount({ companyName: "Test Sub-account", email: "test-sub@example.com", groupIds: ["5f8f8c3b5f56a02d4433b3a7", "5f8f8c3b5f56a02d4433b3a8"], language: "fr", timezone: "Europe/Paris" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCorporateSubAccountRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.associateAnIpToSubAccounts({ ...params }) -> Record<string, unknown>

#### 📝 Description

This endpoint allows to associate an IP to sub-accounts

#### 🔌 Usage

```typescript await client.masterAccount.associateAnIpToSubAccounts({ ids: [234322, 325553, 893432], ip: "103.11.32.88" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCorporateSubAccountIpAssociateRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.dissociateAnIpToSubAccounts({ ...params }) -> void

#### 📝 Description

This endpoint allows to dissociate an IP from sub-accounts

#### 🔌 Usage

```typescript await client.masterAccount.dissociateAnIpToSubAccounts({ ids: [234322, 325553, 893432], ip: "103.11.32.88" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateSubAccountIpDissociateRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.createAnApiKeyForASubAccount({ ...params }) -> Brevo.PostCorporateSubAccountKeyResponse

#### 📝 Description

This endpoint will generate an API v3 key for a sub-account

#### 🔌 Usage

```typescript await client.masterAccount.createAnApiKeyForASubAccount({ id: 3232323, name: "My Api Key" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCorporateSubAccountKeyRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.generateSsoTokenToAccessSubAccount({ ...params }) -> Brevo.GetSsoToken

#### 📝 Description

This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.

#### 🔌 Usage

```typescript await client.masterAccount.generateSsoTokenToAccessSubAccount({ id: 3232323 }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCorporateSubAccountSsoTokenRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.getSubAccountDetails({ ...params }) -> Brevo.GetCorporateSubAccountIdResponse

#### 📝 Description

This endpoint will provide the details for the specified sub-account company

#### 🔌 Usage

```typescript await client.masterAccount.getSubAccountDetails({ id: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCorporateSubAccountIdRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.deleteASubAccount({ ...params }) -> void

#### 📝 Description

Permanently deletes a sub-account from the corporate master account. Once deleted, all data associated with the sub-account organization is removed and cannot be recovered, so ensure the sub-account is no longer needed before proceeding.

#### 🔌 Usage

```typescript await client.masterAccount.deleteASubAccount({ id: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCorporateSubAccountIdRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.enableDisableSubAccountApplicationS({ ...params }) -> void

#### 📝 Description

API endpoint for the Corporate owner to enable/disable applications on the sub-account

#### 🔌 Usage

```typescript await client.masterAccount.enableDisableSubAccountApplicationS({ id: 1000000, "landing-pages": true, meetings: true, "sms-campaigns": false, "web-push": false, whatsapp: true }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateSubAccountIdApplicationsToggleRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.updateSubAccountPlan({ ...params }) -> void

#### 📝 Description

This endpoint will update the sub-account plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1" to set the consumable in unlimited mode.

#### 🔌 Usage

```typescript await client.masterAccount.updateSubAccountPlan({ id: 1000000, credits: { email: 5000, externalFeeds: 1, sms: 2000, whatsapp: 100, wpSubscribers: -1 }, features: { inbox: 10, landingPage: 20, salesUsers: 6, users: 15 } }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateSubAccountIdPlanRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.updateSubAccountsPlan({ ...params }) -> void

#### 📝 Description

This endpoint will update multiple sub-accounts plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1" to set the consumable in unlimited mode.

#### 🔌 Usage

```typescript await client.masterAccount.updateSubAccountsPlan({ credits: { email: 5000, externalFeeds: 1, sms: 2000, whatsapp: 100, wpSubscribers: -1 }, features: { landingPage: 20, salesUsers: 6, users: 15 }, subAccountIds: [4534345, 987893, 876785] }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateSubAccountsPlanRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.inviteAdminUser({ ...params }) -> Brevo.InviteAdminUserResponse

#### 📝 Description

`This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - "all" - `api`: - "none" - `user_management`: - "all" - `app_management` | Not available in ENTv2: - "all" - `sub_organization_groups` - "create" - "edit_delete" - `create_sub_organizations` - "all" - `manage_sub_organizations` - "all" - `analytics` - "download_data" - "create_alerts" - "my_looks" - "explore_create" - `security` - "all" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.

#### 🔌 Usage

```typescript await client.masterAccount.inviteAdminUser({ all_features_access: true, email: "inviteuser@example.com", privileges: [{}] }); ```

#### ⚙️ Parameters

**request:** `Brevo.InviteAdminUserRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.resendCancelAdminUserInvitation({ ...params }) -> Brevo.PutCorporateUserInvitationActionEmailResponse

#### 📝 Description

This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation

#### 🔌 Usage

```typescript await client.masterAccount.resendCancelAdminUserInvitation({ action: "resend", email: "email" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateUserInvitationActionEmailRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.revokeAnAdminUser({ ...params }) -> void

#### 📝 Description

This endpoint allows to revoke/remove an invited member of your Admin account

#### 🔌 Usage

```typescript await client.masterAccount.revokeAnAdminUser({ email: "email" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCorporateUserRevokeEmailRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.getCorporateUserPermission({ ...params }) -> Brevo.GetCorporateUserPermissionResponse

#### 📝 Description

This endpoint will provide the list of admin user permissions

#### 🔌 Usage

```typescript await client.masterAccount.getCorporateUserPermission({ email: "email" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCorporateUserPermissionRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

client.masterAccount.changeAdminUserPermissions({ ...params }) -> void

#### 📝 Description

This endpoint will allow you to change the permissions of Admin users of your Admin account

#### 🔌 Usage

```typescript await client.masterAccount.changeAdminUserPermissions({ email: "email", all_features_access: false, privileges: [{ feature: "user_management", permissions: ["all"] }, { feature: "api", permissions: ["all"] }, { feature: "my_plan", permissions: ["none"] }, { feature: "apps_management", permissions: ["all"] }, { feature: "create_sub_organizations", permissions: ["all"] }, { feature: "sub_organization_groups", permissions: ["create", "edit_delete"] }, { feature: "manage_sub_organizations", permissions: ["all"] }, { feature: "security", permissions: ["none"] }, { feature: "analytics", permissions: ["create_alerts", "download_data", "my_looks", "explore_create"] }] }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutCorporateUserEmailPermissionsRequest`

**requestOptions:** `MasterAccountClient.RequestOptions`

## User

client.user.getInvitedUsersList() -> Brevo.GetInvitedUsersListResponse

#### 📝 Description

Retrieves the list of all users associated with your organization, including both active and pending invited users. Each user entry includes their email address, owner status, current invitation status, and feature access levels for marketing, CRM, and conversations.

#### 🔌 Usage

```typescript await client.user.getInvitedUsersList(); ```

#### ⚙️ Parameters

**requestOptions:** `UserClient.RequestOptions`

client.user.putRevokeUserPermission({ ...params }) -> Brevo.PutRevokeUserPermissionResponse

#### 📝 Description

Revokes all permissions for an invited user in the organization, effectively removing their access to the platform. If the user''s plan change generated credit notes, they are returned in the response for billing reconciliation.

#### 🔌 Usage

```typescript await client.user.putRevokeUserPermission({ email: "email" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutRevokeUserPermissionRequest`

**requestOptions:** `UserClient.RequestOptions`

client.user.inviteuser({ ...params }) -> Brevo.InviteuserResponse

#### 📝 Description

`Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - "create_edit_delete" - "send_schedule_suspend" - `sms_campaigns`: - "create_edit_delete" - "send_schedule_suspend" - `contacts`: - "view" - "create_edit_delete" - "import" - "export" - "list_and_attributes" - "forms" - `templates`: - "create_edit_delete" - "activate_deactivate" - `workflows`: - "create_edit_delete" - "activate_deactivate_pause" - "settings" - `landing_pages`: - "all" - `transactional_emails`: - "settings" - "logs" - `smtp_api`: - "smtp" - "api_keys" - "authorized_ips" - `user_management`: - "all" - `sales_platform`: - "create_edit_deals" - "delete_deals" - "manage_others_deals_tasks" - "reports" - "settings" - `phone`: - "all" - `conversations`: - "access" - "assign" - "configure" - `senders_domains_dedicated_ips`: - "senders_management" - "domains_management" - "dedicated_ips_management" - `push_notifications`: - "view" - "create_edit_delete" - "send" - "settings" - `companies`: - "manage_owned_companies" - "manage_other_companies" - "settings" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.

#### 🔌 Usage

```typescript await client.user.inviteuser({ all_features_access: true, email: "inviteuser@example.com", privileges: [{}] }); ```

#### ⚙️ Parameters

**request:** `Brevo.Inviteuser`

**requestOptions:** `UserClient.RequestOptions`

client.user.putresendcancelinvitation({ ...params }) -> Brevo.PutresendcancelinvitationResponse

#### 📝 Description

Resends or cancels a pending invitation for a user in the organization, depending on the action path parameter. Use `resend` to send a new invitation email to the user, or `cancel` to revoke the pending invitation entirely and remove the user''s pending access.

#### 🔌 Usage

```typescript await client.user.putresendcancelinvitation({ action: "resend", email: "email" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutresendcancelinvitationRequest`

**requestOptions:** `UserClient.RequestOptions`

client.user.editUserPermission({ ...params }) -> Brevo.EditUserPermissionResponse

#### 📝 Description

`Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - "create_edit_delete" - "send_schedule_suspend" - `sms_campaigns`: - "create_edit_delete" - "send_schedule_suspend" - `contacts`: - "view" - "create_edit_delete" - "import" - "export" - "list_and_attributes" - "forms" - `templates`: - "create_edit_delete" - "activate_deactivate" - `workflows`: - "create_edit_delete" - "activate_deactivate_pause" - "settings" - `landing_pages`: - "all" - `transactional_emails`: - "settings" - "logs" - `smtp_api`: - "smtp" - "api_keys" - "authorized_ips" - `user_management`: - "all" - `sales_platform`: - "create_edit_deals" - "delete_deals" - "manage_others_deals_tasks" - "reports" - "settings" - `phone`: - "all" - `conversations`: - "access" - "assign" - "configure" - `senders_domains_dedicated_ips`: - "senders_management" - "domains_management" - "dedicated_ips_management" - `push_notifications`: - "view" - "create_edit_delete" - "send" - "settings" - `companies`: - "manage_owned_companies" - "manage_other_companies" - "settings" **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.

#### 🔌 Usage

```typescript await client.user.editUserPermission({ all_features_access: true, email: "inviteuser@example.com", privileges: [{}] }); ```

#### ⚙️ Parameters

**request:** `Brevo.Inviteuser`

**requestOptions:** `UserClient.RequestOptions`

client.user.getUserPermission({ ...params }) -> Brevo.GetUserPermissionResponse

#### 📝 Description

Retrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address. The response includes the user''s current status (active or pending) and a detailed list of privileges specifying which features and permission levels are granted.

#### 🔌 Usage

```typescript await client.user.getUserPermission({ email: "email" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetUserPermissionRequest`

**requestOptions:** `UserClient.RequestOptions`

## Process

client.process.getProcesses({ ...params }) -> Brevo.GetProcessesResponse

#### 📝 Description

Retrieves a list of background processes from your Brevo account with filtering and pagination. **Use this to:** - Monitor background process activity and status - Track long-running operations and tasks - Find process IDs for detailed status checking - Review process history and performance - Identify failed or stuck processes for troubleshooting **Key information returned:** - Process details (ID, name, status) - Export download URLs for completed export processes - Import details with CSV report URLs for completed import processes - Total count of processes for pagination **Important considerations:** - Background processes handle long-running operations like imports and exports - Process status indicates current state (queued, processing, completed) - Export processes provide download URLs when completed - Import processes provide CSV report URLs with details about problematic records - Use pagination for accounts with many historical processes - Sort options available for creation order (ascending or descending) - Default limit is 10 results per page, maximum is 50

#### 🔌 Usage

```typescript await client.process.getProcesses(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetProcessesRequest`

**requestOptions:** `ProcessClient.RequestOptions`

client.process.getProcess({ ...params }) -> Brevo.GetProcessResponse

#### 📝 Description

Retrieves detailed information about a specific background process. **Use this to:** - Get detailed status of a specific process - Monitor process progress and completion - Download results from completed export processes - Check error details for failed processes - Track process execution times **Key information returned:** - Complete process details (ID, name, status) - Download URLs for completed export processes - Import details with CSV report URLs for completed import processes **Important considerations:** - Process ID must exist in your account and not be deleted - Completed export processes include download URLs - Completed import processes include CSV report URLs with details about problematic records - Different process types return different result structures

#### 🔌 Usage

```typescript await client.process.getProcess({ processId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetProcessRequest`

**requestOptions:** `ProcessClient.RequestOptions`

## Senders

client.senders.getSenders({ ...params }) -> Brevo.GetSendersResponse

#### 📝 Description

Retrieves a list of all email senders from your Brevo account with optional filtering. **Use this to:** - Get all available senders for email campaign setup - Find sender details including ID, name, and email address - Filter senders by IP address for dedicated IP users - Filter senders by domain for domain-specific configurations - Monitor sender configuration and status **Key information returned:** - Sender details (ID, name, email address) - Sender status and verification information - Associated IP addresses and domains (for dedicated IP accounts) - Sender configuration settings **Important considerations:** - Standard accounts show empty IP arrays, dedicated IP accounts show IP assignments - Filtering by IP only available for accounts with dedicated IPs - Domain filtering helps organize senders by business units or brands - Sender status indicates if sender is active and ready for campaign use - Email verification required before sender can be used in campaigns

#### 🔌 Usage

```typescript await client.senders.getSenders(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSendersRequest`

**requestOptions:** `SendersClient.RequestOptions`

client.senders.createSender({ ...params }) -> Brevo.CreateSenderResponse

#### 📝 Description

Creates a new email sender in your Brevo account. **Use this to:** - Add new senders for email campaigns - Configure sender identity (name and email) - Associate dedicated IPs with the sender (for dedicated IP accounts) - Set up domain-based sender configurations **Key information returned:** - Created sender ID - DKIM and SPF configuration status - Success confirmation **Important considerations:** - Verification email sent to specified sender address - DKIM and SPF configuration affects deliverability - Dedicated IP accounts require IP association during creation - IP weights must sum to 100 when specified - Sender must be verified before use in campaigns

#### 🔌 Usage

```typescript await client.senders.createSender({ email: "support@example.com", name: "Support Team" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateSenderRequest`

**requestOptions:** `SendersClient.RequestOptions`

client.senders.getIps() -> Brevo.GetIpsResponse

#### 📝 Description

Retrieves all dedicated IPs associated with your Brevo account. Use this to: - List all your dedicated IPs - Check the status of your dedicated IPs (active/inactive) - Find IP addresses and associated domains for configuration purposes - Monitor your IP reputation and deliverability - Verify available IPs for sender configuration Key information returned: - IP ID and address - Associated domain - Active status - IP configuration details

#### 🔌 Usage

```typescript await client.senders.getIps(); ```

#### ⚙️ Parameters

**requestOptions:** `SendersClient.RequestOptions`

client.senders.updateSender({ ...params }) -> void

#### 📝 Description

Updates an existing email sender's configuration. Use this to: - Modify sender display name or email address - Update dedicated IP associations - Change sender configuration settings - Correct sender information Key information returned: - Success confirmation - Updated sender details

#### 🔌 Usage

```typescript await client.senders.updateSender({ senderId: 1000000, name: "New Support Team" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateSenderRequest`

**requestOptions:** `SendersClient.RequestOptions`

client.senders.deleteSender({ ...params }) -> void

#### 📝 Description

Deletes an email sender from your Brevo account. Use this to: - Remove senders that are no longer needed - Clean up sender configurations - Remove duplicate or test senders Key information returned: - Success confirmation message

#### 🔌 Usage

```typescript await client.senders.deleteSender({ senderId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteSenderRequest`

**requestOptions:** `SendersClient.RequestOptions`

client.senders.getIpsFromSender({ ...params }) -> Brevo.GetIpsFromSenderResponse

#### 📝 Description

Retrieves the dedicated IPs associated with a specific sender. Use this to: - Check IP configuration for a sender - Verify dedicated IP associations - Get IP details for troubleshooting - Monitor sender IP configuration Key information returned: - List of associated dedicated IPs - IP addresses and domain configurations - IP status and settings

#### 🔌 Usage

```typescript await client.senders.getIpsFromSender({ senderId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetIpsFromSenderRequest`

**requestOptions:** `SendersClient.RequestOptions`

client.senders.validateSenderByOtp({ ...params }) -> void

#### 📝 Description

Validates a sender using the OTP (One-Time Password) received via email. Use this to: - Complete sender verification process - Activate a newly created sender - Verify ownership of the sender email address - Enable the sender for use in email campaigns Key information returned: - Success confirmation of sender verification - Sender activation status

#### 🔌 Usage

```typescript await client.senders.validateSenderByOtp({ senderId: 1000000, otp: 123456 }); ```

#### ⚙️ Parameters

**request:** `Brevo.ValidateSenderByOtpRequest`

**requestOptions:** `SendersClient.RequestOptions`

## Domains

client.domains.getDomains() -> Brevo.GetDomainsResponse

#### 📝 Description

Retrieves all domains associated with the account. Use this to: - List all domains - Verify domain existence - Check domain authentication and verification status - Monitor domain configuration and provider information - Review domain creation history and ownership Key information returned: - Domain details (ID, name, authentication status) - Verification and authentication states - Associated IP addresses and DNS providers - Creator information and creation timestamps - Pagination information for large domain lists

#### 🔌 Usage

```typescript await client.domains.getDomains(); ```

#### ⚙️ Parameters

**requestOptions:** `DomainsClient.RequestOptions`

client.domains.createDomain({ ...params }) -> Brevo.CreateDomainResponse

#### 📝 Description

Creates a new domain in Brevo. Use this to: - Add new domains for sending emails - Set up domain authentication for better deliverability - Configure DNS records for email authentication - Establish domain-based sender identities Key information returned: - Created domain ID and configuration - Required DNS records for authentication - Domain provider detection results - Setup instructions and next steps

#### 🔌 Usage

```typescript await client.domains.createDomain({ name: "mycompany.com" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateDomainRequest`

**requestOptions:** `DomainsClient.RequestOptions`

client.domains.getDomainConfiguration({ ...params }) -> Brevo.GetDomainConfigurationResponse

#### 📝 Description

Retrieves configuration of a specific domain, to know if the domain is valid or not. Use this to: - Check domain configuration - Validate a domain configuration - Monitor DNS record status - Troubleshoot authentication issues Key information returned: - Domain verification and authentication status - DNS records configuration and validation status - Detailed authentication requirements

#### 🔌 Usage

```typescript await client.domains.getDomainConfiguration({ domainName: "domainName" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetDomainConfigurationRequest`

**requestOptions:** `DomainsClient.RequestOptions`

client.domains.deleteDomain({ ...params }) -> void

#### 📝 Description

Deletes a domain from Brevo. Use this to: - Remove existing domains - Clean up unused domain configurations - Remove test domains Key information returned: - Success confirmation message

#### 🔌 Usage

```typescript await client.domains.deleteDomain({ domainName: "domainName" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteDomainRequest`

**requestOptions:** `DomainsClient.RequestOptions`

client.domains.authenticateDomain({ ...params }) -> Brevo.AuthenticateDomainResponse

#### 📝 Description

Authenticates a specific domain. Use this to: - Authenticate a domain - Verify DNS record configuration - Complete domain setup for sending - Enable domain for email authentication Key information returned: - Authentication success confirmation - Domain readiness status for email sending

#### 🔌 Usage

```typescript await client.domains.authenticateDomain({ domainName: "domainName" }); ```

#### ⚙️ Parameters

**request:** `Brevo.AuthenticateDomainRequest`

**requestOptions:** `DomainsClient.RequestOptions`

## Webhooks

client.webhooks.getWebhooks({ ...params }) -> Brevo.GetWebhooksResponse

#### 📝 Description

Retrieves all webhooks from your Brevo account with filtering and sorting options. Use this to: - Monitor webhook configurations and event handling - List webhooks by type (transactional, marketing, inbound) - Review webhook endpoints and authentication - Track webhook creation and modification history - Audit webhook event subscriptions Key information returned: - Complete webhook details and configuration - Event types and channel subscriptions - Authentication and security settings - Webhook URLs and custom headers - Creation and modification timestamps

#### 🔌 Usage

```typescript await client.webhooks.getWebhooks(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetWebhooksRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.createWebhook({ ...params }) -> Brevo.CreateWebhookResponse

#### 📝 Description

Creates a new webhook to receive real-time notifications for specified events. Use this to: - Set up event notifications for transactional or marketing emails - Configure webhook endpoints for campaign tracking - Enable real-time monitoring of email delivery status - Subscribe to contact list changes and updates - Implement custom event handling and automation Key information returned: - Created webhook ID and configuration - Success confirmation and setup details

#### 🔌 Usage

```typescript await client.webhooks.createWebhook({ url: "http://requestb.in/173lyyx1" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateWebhookRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.exportWebhooksHistory({ ...params }) -> Brevo.ExportWebhooksHistoryResponse

#### 📝 Description

This is an enterprise feature. Contact us to activate it for your account. Submits a request to export webhook event history as a CSV file. The download link is sent to the `notifyURL` you provide in the request body. Use this endpoint to: - Export webhook event history filtered by date range, event type, or email address - Generate reports for compliance, auditing, or performance analysis - Track delivery patterns and webhook reliability over time

#### 🔌 Usage

```typescript await client.webhooks.exportWebhooksHistory({ event: "invalid_parameter", notifyURL: "https://brevo.com", type: "transactional" }); ```

#### ⚙️ Parameters

**request:** `Brevo.ExportWebhooksHistoryRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.getWebhook({ ...params }) -> Brevo.GetWebhook

#### 📝 Description

Retrieves detailed information about a specific webhook configuration. Use this to: - Get complete webhook configuration and settings - Check webhook event subscriptions and triggers - Review authentication and security settings - Verify webhook URL and custom headers - Access webhook creation and modification history Key information returned: - Complete webhook details and configuration - Event types and channel subscriptions - Authentication credentials and methods - Custom headers and request settings - Webhook status and activity information

#### 🔌 Usage

```typescript await client.webhooks.getWebhook({ webhookId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetWebhookRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.updateWebhook({ ...params }) -> void

#### 📝 Description

Updates an existing webhook configuration and event subscriptions. Use this to: - Modify webhook event subscriptions and triggers - Update webhook URL and endpoint configuration - Change authentication settings and credentials - Adjust custom headers and request parameters - Enable or disable specific webhook events Key information returned: - Success confirmation of webhook updates

#### 🔌 Usage

```typescript await client.webhooks.updateWebhook({ webhookId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateWebhookRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.deleteWebhook({ ...params }) -> void

#### 📝 Description

Permanently deletes a webhook and stops all event notifications. Use this to: - Remove unused or obsolete webhook configurations - Clean up webhook endpoints and subscriptions - Stop event notifications to specific URLs - Maintain organized webhook management Key information returned: - Success confirmation of webhook deletion

#### 🔌 Usage

```typescript await client.webhooks.deleteWebhook({ webhookId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteWebhookRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

## ExternalFeeds

client.externalFeeds.getAllExternalFeeds({ ...params }) -> Brevo.GetAllExternalFeedsResponse

#### 📝 Description

Retrieves all external feeds from your Brevo account with filtering and pagination. **Use this to:** - Get an overview of all external data feeds - Find feeds by name using search functionality - Filter feeds by creation date range - Browse feeds by authentication type - Monitor feed library organization and usage **Key information returned:** - Feed details (UUID, name, URL, authentication type) - Feed configuration and settings - Creation and modification timestamps - Feed status and error information - Authentication and header configurations **Important considerations:** - External feeds enable dynamic content in email campaigns - Feeds must be accessible from Brevo servers - Authentication credentials are securely stored - Feed performance affects campaign delivery - Use pagination for accounts with many feeds - Date range filtering limited to 30 days maximum - Search functionality works on feed name matching - Internal feeds are system-managed and cannot be modified

#### 🔌 Usage

```typescript await client.externalFeeds.getAllExternalFeeds({ search: "product", startDate: "2024-01-01", endDate: "2024-01-31" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetAllExternalFeedsRequest`

**requestOptions:** `ExternalFeedsClient.RequestOptions`

client.externalFeeds.createExternalFeed({ ...params }) -> Brevo.CreateExternalFeedResponse

#### 📝 Description

Creates a new external feed for dynamic content in email campaigns. **Use this to:** - Set up external data sources for dynamic content - Configure authentication for protected feeds - Enable real-time content updates in campaigns - Establish connections to product catalogs, blogs, or APIs **Key information returned:** - Created feed UUID for reference in campaigns - Success confirmation **Important considerations:** - Feed URL must be accessible from Brevo infrastructure - Authentication credentials are securely encrypted - Test feed accessibility before campaign use - Consider feed response time for campaign performance - Monitor feed reliability and uptime - Use caching for frequently accessed feeds - Maximum 5 retry attempts allowed for failed requests - Custom headers support for API integration requirements

#### 🔌 Usage

```typescript await client.externalFeeds.createExternalFeed({ name: "Public API Feed", url: "https://jsonplaceholder.typicode.com/posts", authType: "noAuth", maxRetries: 3, cache: true }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateExternalFeedRequest`

**requestOptions:** `ExternalFeedsClient.RequestOptions`

client.externalFeeds.getExternalFeedByUuid({ ...params }) -> Brevo.GetExternalFeedByUuidResponse

#### 📝 Description

Retrieves details of a specific external feed by its UUID. **Use this to:** - Get complete configuration of an external feed - Check feed authentication settings - Review feed personalization options - Verify feed URL and parameters - Monitor feed modification history **Key information returned:** - Complete feed configuration and settings - Authentication credentials and headers - Personalization and fallback settings - Creation and modification timestamps - Cache and retry configurations **Important considerations:** - UUID must exist in your account - Provides complete feed information for troubleshooting - Essential before making modifications - Shows current feed health status - Useful for debugging feed issues

#### 🔌 Usage

```typescript await client.externalFeeds.getExternalFeedByUuid({ uuid: "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetExternalFeedByUuidRequest`

**requestOptions:** `ExternalFeedsClient.RequestOptions`

client.externalFeeds.updateExternalFeed({ ...params }) -> void

#### 📝 Description

Updates configuration of an existing external feed. **Use this to:** - Update feed URLs when data sources change - Modify authentication credentials - Change cache and retry settings - Update custom headers - Rename feeds for better organization **Key information returned:** - Success confirmation message **Important considerations:** - Only provided fields will be updated - Feed UUID must exist in your account - Authentication changes require verification - URL changes should be tested before campaign use - Monitor campaigns using this feed after updates

#### 🔌 Usage

```typescript await client.externalFeeds.updateExternalFeed({ uuid: "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6", name: "Updated Product Catalog", url: "https://api.newstore.com/products/v2" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateExternalFeedRequest`

**requestOptions:** `ExternalFeedsClient.RequestOptions`

client.externalFeeds.deleteExternalFeed({ ...params }) -> void

#### 📝 Description

Deletes an external feed from your Brevo account. **Use this to:** - Remove external feeds that are no longer needed - Clean up unused data sources - Remove test or outdated feeds - Maintain organized feed library **Key information returned:** - Success confirmation message **Important considerations:** - This action is PERMANENT and cannot be undone - Feed configuration and history will be lost - Check if feed is used in active campaigns before deletion - Remove feed references from email templates - Consider deactivating instead of deleting if unsure

#### 🔌 Usage

```typescript await client.externalFeeds.deleteExternalFeed({ uuid: "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteExternalFeedRequest`

**requestOptions:** `ExternalFeedsClient.RequestOptions`

## CustomObjects

client.customObjects.upsertrecords({ ...params }) -> Brevo.UpsertrecordsResponse

#### 📝 Description

Custom objects are only available to Enterprise plans. This feature is in beta. These are subject to change. Performs bulk create or update (upsert) operations for object records in a single asynchronous request. This endpoint is optimized for high-volume data imports and synchronization scenarios. **How Upsert Works:** - **Create**: Omit `identifiers`, or provide only `ext_id` (if it doesn't already exist). A new record is created with a Brevo-generated `id`. - **Update**: Provide `id` (Brevo internal ID) or an `ext_id` that already exists. The matching record is updated with the new attribute values. - **Important:** `id` is for **updates only**. Providing an `id` that does not belong to an existing record will fail during async processing (the HTTP response will still be 202, but the record will be rejected in the background). To create a new record with a stable external reference, use `ext_id` instead. **Request Structure:** Each object record in the `records` array can include: - `identifiers`: Either `id` (internal Brevo ID) or `ext_id` (your external system ID) — required for updates. **Note:** use `id` (singular), not `ids`. - `attributes`: Key-value pairs where each key is the attribute **key** (e.g., `company_name`), not the attribute label (e.g., "Company Name"). - `associations`: Controls linking and unlinking of associated records (optional). Each entry specifies: - `object_type`: The type of the associated object - `action`: `link` (default) to create the association, or `unlink` to remove it - `records`: The associated records to link or unlink (each identified by `ext_id` or `id`) - **Unlink is idempotent** — unlinking a non-existing association is a no-op (no error returned) - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry - Both associated records must already exist before a link can be created > **Common mistake:** Passing the attribute **label** (the display name you see in the UI) instead of the attribute **key** will cause the attribute to be silently ignored and the record may not be created as expected. **Asynchronous Processing:** - Returns immediately with a `processId` (HTTP 202 Accepted) - Use the processId to track status via the Get process API **API and Schema Limitations:** - Max 1000 object records per request - Max request body size: 1 MB - Max 500 attributes per object record (matches the schema limit of 500 attributes per object) - Unknown attribute keys are silently ignored (no error, no attribute creation) - Max 10 association records per associated object-type in each record of the request. If you need more, send multiple requests. **Important Behaviors:** - The object schema must be created before upserting records - Unknown attribute keys are silently ignored (no error, no creation) - Both associated object records must already exist before creating a link association - Unlink operations are idempotent: attempting to unlink a non-existing association returns success - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry - Contact objects cannot be created via this endpoint - For `category` and `multiple_category` attributes, pass the option **key** as the value (not the option label or option ID). - The `id` identifier (internal Brevo ID) can only be used for **updating** existing records. To create new records, either omit identifiers (Brevo auto-generates an ID) or provide an `ext_id`. **Errors:** - Make sure both object records exist before associating them, else the API will return an error. - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".

#### 🔌 Usage

```typescript await client.customObjects.upsertrecords({ object_type: "vehicle", records: [{ associations: [{ object_type: "garage", action: "link", records: [{ identifiers: { id: 435435 } }] }, { object_type: "garage", action: "unlink", records: [{ identifiers: { ext_id: "old-garage-001" } }] }], attributes: { "make": "Toyota", "model": "Camry", "year": 2020, "engine_type": "hybrid" }, identifiers: { ext_id: "VIN123" } }] }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpsertrecordsRequest`

**requestOptions:** `CustomObjectsClient.RequestOptions`

client.customObjects.getrecords({ ...params }) -> Brevo.GetrecordsResponse

#### 📝 Description

Custom objects are only available to Enterprise plans. This feature is in beta. These are subject to change. This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. **Note**: Contact as object type is not supported in this endpoint.

#### 🔌 Usage

```typescript await client.customObjects.getrecords({ object_type: "vehicle", limit: 1000000, page_num: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetrecordsRequest`

**requestOptions:** `CustomObjectsClient.RequestOptions`

client.customObjects.batchDeleteObjectRecords({ ...params }) -> Brevo.BatchDeleteObjectRecordsResponse

#### 📝 Description

Use this endpoint to delete multiple object records of the same object-type in one request. The request is accepted and processed asynchronously. You can track the status of the deletion process using the returned **processId**. **Limitations:** - Each request can contain up to **1000** object record identifiers - Either `ids` or `ext_ids` must be provided, but **not both** in the same request - Deletion of Brevo standard object records is not supported via this endpoint - If more records must be deleted, send multiple batch requests

#### 🔌 Usage

```typescript await client.customObjects.batchDeleteObjectRecords({ object_type: "vehicle", identifiers: { ext_ids: ["ext-001", "ext-002"] } }); ```

#### ⚙️ Parameters

**request:** `Brevo.BatchDeleteObjectRecordsRequest`

**requestOptions:** `CustomObjectsClient.RequestOptions`

client.customObjects.getAssociatedRecords({ ...params }) -> Brevo.GetAssociatedRecordsResponse

#### 📝 Description

Custom objects are only available to Enterprise plans. This feature is in beta. These are subject to change. Returns the records associated with a single source record. Associations of every type are returned together in one paginated list, ordered by association creation time with the most recently created association first. **Identifying the source record** Provide exactly one of `id`, `ext_id`, `email` or `sms`. Passing none of them, or more than one, returns `400`. `email` and `sms` are only accepted when `object_type` is `contact`; using either with any other object type returns `400`. **Object types** Use the object type exactly as it is defined in your account, for example `vehicle` for a custom object of that name, or `contact` for contacts. An object type that does not exist in your account returns `400`. **Filtering by associated object type** Use `type` to restrict the response to one or more associated object types, for example `?type=contact&type=garage`. Up to 5 types can be requested per call; more returns `400`. When `type` is omitted, associations of every type are returned. **Pagination** Results are returned 20 per page. The page size is fixed and cannot be changed. Increase `offset` by 20 to walk through the pages until `has_more` is `false`. An `offset` beyond the last record returns an empty `items` array with `has_more` set to `false`. **Working with contacts** - `contact` is supported both as the source `object_type` and as an associated object type. - An `id`, `ext_id`, `email` or `sms` that matches no contact returns `404`. - If several contacts share the same `ext_id`, `email` or `sms`, identify the contact by `id` to be sure of which one is used. - Contacts returned in `items` carry all of the contact's attributes, with attribute keys in lowercase — `email`, `first_name`, `last_name`, `sms`, `ext_id`, and any other contact attribute lowercased. - For contacts, `ext_id`, `created_at` and `updated_at` are not returned on `object`. A contact's external ID is available as `attributes.ext_id` when it is set.

#### 🔌 Usage

```typescript await client.customObjects.getAssociatedRecords({ object_type: "vehicle", id: 16789, ext_id: "507f1f77bc", email: "jane.doe@example.com", sms: "33612345678", offset: 0 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetAssociatedRecordsRequest`

**requestOptions:** `CustomObjectsClient.RequestOptions`

## Contacts

client.contacts.getContacts({ ...params }) -> Brevo.GetContacts

#### 📝 Description

Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting. Results default to 50 contacts per page (maximum 1000) sorted in descending order of creation, and can be filtered by modification date, creation date, contact IDs (up to 20), list IDs, segment ID, or contact attributes using the equals operator. Note that either listIds or segmentId can be passed but not both simultaneously.

#### 🔌 Usage

```typescript await client.contacts.getContacts(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetContactsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.createContact({ ...params }) -> Brevo.CreateContactResponse | undefined

#### 📝 Description

Follow this format when passing a "SMS" phone number as an attribute. Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx Creates new contacts on Brevo. Contacts can be created by passing either -

1. email address of the contact (email_id),
2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}
3. ext_id

#### 🔌 Usage

```typescript await client.contacts.createContact(); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateContactRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getAttributes() -> Brevo.GetAttributesResponse

#### 📝 Description

Retrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global). Each attribute includes its name, type, and category, along with enumeration values for category-type attributes and options for multiple-choice-type attributes.

#### 🔌 Usage

```typescript await client.contacts.getAttributes(); ```

#### ⚙️ Parameters

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.createAttribute({ ...params }) -> void

#### 📝 Description

Create a new contact attribute under the specified category and name. The required body properties depend on the category: use "type" for normal, transactional, or category attributes; use "value" for calculated or global attributes; use "enumeration" for category attributes; and use "multiCategoryOptions" for normal multiple-choice attributes. None of the category or multicategory option values can exceed 200 characters.

#### 🔌 Usage

```typescript await client.contacts.createAttribute({ attributeCategory: "normal", attributeName: "attributeName" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateAttributeRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.updateAttribute({ ...params }) -> void

#### 📝 Description

Update an existing contact attribute identified by its category and name. For category-type attributes, you can update the enumeration values; for calculated or global attributes, update the computed value formula; and for normal multiple-choice attributes, update the multicategory options. None of the category or multicategory option values can exceed 200 characters.

#### 🔌 Usage

```typescript await client.contacts.updateAttribute({ attributeCategory: "category", attributeName: "attributeName" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateAttributeRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.deleteAttribute({ ...params }) -> void

#### 📝 Description

Permanently delete an existing contact attribute by its category and name. The attribute must exist in the specified category (normal, transactional, category, calculated, or global), otherwise a 404 error is returned.

#### 🔌 Usage

```typescript await client.contacts.deleteAttribute({ attributeCategory: "normal", attributeName: "attributeName" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteAttributeRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.deleteMultiAttributeOptions({ ...params }) -> void

#### 📝 Description

Delete a specific option from an existing multiple-choice contact attribute. The attribute type must be "multiple-choice", and both the attribute name and the option to delete must already exist in your account.

#### 🔌 Usage

```typescript await client.contacts.deleteMultiAttributeOptions({ attributeType: "multiple-choice", multipleChoiceAttribute: "multipleChoiceAttribute", multipleChoiceAttributeOption: "multipleChoiceAttributeOption" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteMultiAttributeOptionsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.updateBatchContacts({ ...params }) -> void

#### 📝 Description

Update multiple contacts in a single API call by passing an array of contact objects. Each contact in the array must be identified by one of: email, id, or sms (only one identifier per contact). You can update attributes, blacklist status, list memberships, ext_id, and transactional email forbidden senders for each contact in the batch.

#### 🔌 Usage

```typescript await client.contacts.updateBatchContacts(); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateBatchContactsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.createDoiContact({ ...params }) -> void

#### 📝 Description

attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.

#### 🔌 Usage

```typescript await client.contacts.createDoiContact({ email: "elly@example.com", includeListIds: [36], redirectionUrl: "http://requestb.in/173lyyx1", templateId: 2 }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateDoiContactRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.requestContactExport({ ...params }) -> Brevo.RequestContactExportResponse

#### 📝 Description

It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

#### 🔌 Usage

```typescript await client.contacts.requestContactExport({ customContactFilter: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.RequestContactExportRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getFolders({ ...params }) -> Brevo.GetFoldersResponse

#### 📝 Description

Ongoing changes for this endpoint We're dropping support for the response attributes totalSubscribers and totalBlacklisted. These are non breaking changes. The default value for the attributes will be 0. The uniqueSubscribers field is deprecated

#### 🔌 Usage

```typescript await client.contacts.getFolders(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetFoldersRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.createFolder({ ...params }) -> Brevo.CreateFolderResponse

#### 📝 Description

Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together. The folder name is required and must be provided in the request body.

#### 🔌 Usage

```typescript await client.contacts.createFolder({}); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateUpdateFolder`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getFolder({ ...params }) -> Brevo.GetFolder

#### 📝 Description

Ongoing changes for this endpoint. We're dropping support for the response attributes totalSubscribers and totalBlacklisted. These are non breaking changes. The default value for the attributes will be 0.

#### 🔌 Usage

```typescript await client.contacts.getFolder({ folderId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetFolderRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.updateFolder({ ...params }) -> void

#### 📝 Description

Update the name of an existing folder identified by its ID. The new folder name must be provided in the request body. Returns a 404 error if the folder ID does not exist.

#### 🔌 Usage

```typescript await client.contacts.updateFolder({ folderId: 1000000, body: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateFolderRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.deleteFolder({ ...params }) -> void

#### 📝 Description

Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it. This action cannot be undone.

#### 🔌 Usage

```typescript await client.contacts.deleteFolder({ folderId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteFolderRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getFolderLists({ ...params }) -> Brevo.GetFolderListsResponse

#### 📝 Description

#### 🔌 Usage

```typescript await client.contacts.getFolderLists({ folderId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetFolderListsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.importContacts({ ...params }) -> Brevo.ImportContactsResponse

#### 📝 Description

It returns the background process ID which on completion calls the notify URL that you have set in the input. **Note**: - Any contact attribute that doesn't exist in your account will be ignored at import end.

#### 🔌 Usage

```typescript await client.contacts.importContacts(); ```

#### ⚙️ Parameters

**request:** `Brevo.ImportContactsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getLists({ ...params }) -> Brevo.GetListsResponse

#### 📝 Description

#### 🔌 Usage

```typescript await client.contacts.getLists(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetListsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.createList({ ...params }) -> Brevo.CreateListResponse

#### 📝 Description

Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.

#### 🔌 Usage

```typescript await client.contacts.createList({ folderId: 2, name: "Magento Customer - ES" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateListRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getList({ ...params }) -> Brevo.GetListResponse

#### 📝 Description

Retrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics. You can optionally filter campaign statistics by providing startDate and endDate parameters (both must be used together in YYYY-MM-DD format).

#### 🔌 Usage

```typescript await client.contacts.getList({ listId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetListRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.updateList({ ...params }) -> void

#### 📝 Description

Update an existing contact list identified by its ID. You can update the list name, move it to a different folder by providing a new folderId, or both. Only one of the two parameters (name, folderId) needs to be provided per request.

#### 🔌 Usage

```typescript await client.contacts.updateList({ listId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateListRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.deleteList({ ...params }) -> void

#### 📝 Description

Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list. Returns a 404 error if the list ID does not exist.

#### 🔌 Usage

```typescript await client.contacts.deleteList({ listId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteListRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getContactsFromList({ ...params }) -> Brevo.GetContacts

#### 📝 Description

Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.

#### 🔌 Usage

```typescript await client.contacts.getContactsFromList({ listId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetContactsFromListRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.addContactToList({ ...params }) -> Brevo.PostContactInfo

#### 🔌 Usage

```typescript await client.contacts.addContactToList({ listId: 1000000, body: { emails: ["jeff32@example.com", "jim56@example.com"] } }); ```

#### ⚙️ Parameters

**request:** `Brevo.AddContactToListRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.removeContactFromList({ ...params }) -> Brevo.PostContactInfo

#### 🔌 Usage

```typescript await client.contacts.removeContactFromList({ listId: 1000000, body: { all: true } }); ```

#### ⚙️ Parameters

**request:** `Brevo.RemoveContactFromListRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getSegments({ ...params }) -> Brevo.GetSegmentsResponse

#### 📝 Description

Retrieve all contact segments defined in your Brevo account with support for pagination and sorting. Results default to 10 segments per page (maximum 50) sorted in descending order of creation. Each segment includes its ID, name, category name, and last update timestamp.

#### 🔌 Usage

```typescript await client.contacts.getSegments(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSegmentsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getContactInfo({ ...params }) -> Brevo.GetContactInfoResponse

#### 📝 Description

Follow this format when passing a "SMS" phone number as an attribute. Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx There are 2 ways to get a contact

Option 1- https://api.brevo.com/v3/contacts/{identifier}

Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={}

Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact.

Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute

Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.

#### 🔌 Usage

```typescript await client.contacts.getContactInfo({ identifier: "identifier" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetContactInfoRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.updateContact({ ...params }) -> void

#### 📝 Description

Follow this format when passing a "SMS" phone number as an attribute. Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx

If a blocklisted contact's email address is updated, it is going to remove that blocklisting from the contact and they will be resubscribed. There are 2 ways to update a contact

Option 1- https://api.brevo.com/v3/contacts/{identifier}

Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={}

Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.

Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute

#### 🔌 Usage

```typescript await client.contacts.updateContact({ identifier: "identifier" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateContactRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.deleteContact({ ...params }) -> void

#### 📝 Description

There are 2 ways to delete a contact

Option 1- https://api.brevo.com/v3/contacts/{identifier}

Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={}

Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact.

Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute.

#### 🔌 Usage

```typescript await client.contacts.deleteContact({ identifier: "identifier" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteContactRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getContactStats({ ...params }) -> Brevo.GetContactStatsResponse

#### 📝 Description

Retrieve email campaign statistics for a specific contact identified by email address or numeric ID. Statistics include messages sent, opens, clicks, hard/soft bounces, deliveries, unsubscriptions, complaints, and transactional attributes. By default, data covers the last 90 days; use startDate and endDate parameters (YYYY-MM-DD) to specify a custom range with a maximum span of 90 days.

#### 🔌 Usage

```typescript await client.contacts.getContactStats({ identifier: "identifier" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetContactStatsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

## ConsentGroups

client.consentGroups.getConsentGroups({ ...params }) -> Brevo.ConsentGroupsListResponse

#### 📝 Description

Returns a paginated list of consent groups for the account. This endpoint is only available when the Consent Groups feature is enabled for your account. Returns `403` if the feature is not activated.

#### 🔌 Usage

```typescript await client.consentGroups.getConsentGroups(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetConsentGroupsRequest`

**requestOptions:** `ConsentGroupsClient.RequestOptions`

client.consentGroups.createConsentGroup({ ...params }) -> Brevo.ConsentGroup

#### 📝 Description

Creates a new consent group for the account. This endpoint is only available when the Consent Groups feature is enabled for your account.

#### 🔌 Usage

```typescript await client.consentGroups.createConsentGroup({ name: "Newsletter EU", signupMode: "manual" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateConsentGroupRequest`

**requestOptions:** `ConsentGroupsClient.RequestOptions`

client.consentGroups.getConsentGroup({ ...params }) -> Brevo.ConsentGroup

#### 📝 Description

Returns a single consent group by ID for the account. This endpoint is only available when the Consent Groups feature is enabled for your account.

#### 🔌 Usage

```typescript await client.consentGroups.getConsentGroup({ id: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetConsentGroupRequest`

**requestOptions:** `ConsentGroupsClient.RequestOptions`

client.consentGroups.updateConsentGroup({ ...params }) -> Brevo.ConsentGroup

#### 📝 Description

Updates name, description, or signupMode of a consent group. At least one field must be provided. This endpoint is only available when the Consent Groups feature is enabled for your account.

#### 🔌 Usage

```typescript await client.consentGroups.updateConsentGroup({ id: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateConsentGroupRequest`

**requestOptions:** `ConsentGroupsClient.RequestOptions`

client.consentGroups.deleteConsentGroup({ ...params }) -> void

#### 📝 Description

Deletes a consent group by ID and removes it from all associated contacts. This endpoint is only available when the Consent Groups feature is enabled for your account.

#### 🔌 Usage

```typescript await client.consentGroups.deleteConsentGroup({ id: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteConsentGroupRequest`

**requestOptions:** `ConsentGroupsClient.RequestOptions`

## Conversations

client.conversations.setsAgentsStatusToOnlineFor23Minutes({ ...params }) -> void

#### 📝 Description

Sets the agent's status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom`.

#### 🔌 Usage

```typescript await client.conversations.setsAgentsStatusToOnlineFor23Minutes({ agentId: "d9nKoegKSjmCtyK78" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostConversationsAgentOnlinePingRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.sendAMessageAsAnAgent({ ...params }) -> Brevo.ConversationsMessage

#### 📝 Description

Send a message as an agent to an existing visitor's conversation. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.

#### 🔌 Usage

```typescript await client.conversations.sendAMessageAsAnAgent({ agentId: "d9nKoegKSjmCtyK78", text: "Hello! How can I help you?", visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostConversationsMessagesRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.getAMessage({ ...params }) -> Brevo.ConversationsMessage

#### 📝 Description

Retrieve a single message by its ID.

#### 🔌 Usage

```typescript await client.conversations.getAMessage({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetConversationsMessagesIdRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.updateAMessageSentByAnAgent({ ...params }) -> Brevo.ConversationsMessage

#### 📝 Description

Update the text of a message sent by an agent. Only messages of type `agent` can be edited. The `text` and `html` fields of the message will be updated.

#### 🔌 Usage

```typescript await client.conversations.updateAMessageSentByAnAgent({ id: "id", text: "Good morning! How can I help you?" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutConversationsMessagesIdRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.deleteAMessageSentByAnAgent({ ...params }) -> void

#### 📝 Description

Delete a message sent by an agent. Only messages of type `agent` can be deleted.

#### 🔌 Usage

```typescript await client.conversations.deleteAMessageSentByAnAgent({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteConversationsMessagesIdRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.sendAnAutomatedMessageToAVisitor({ ...params }) -> Brevo.ConversationsMessage

#### 📝 Description

Send an automated (pushed) message to a visitor on behalf of an agent. Example use cases: order status updates, announcing new features in your web app, etc.

#### 🔌 Usage

```typescript await client.conversations.sendAnAutomatedMessageToAVisitor({ groupId: "PjRBMhWGen6aRHjif", text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88", visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostConversationsPushedMessagesRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.getAnAutomatedMessage({ ...params }) -> Brevo.ConversationsMessage

#### 📝 Description

Retrieve a single automated (pushed) message by its ID.

#### 🔌 Usage

```typescript await client.conversations.getAnAutomatedMessage({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetConversationsPushedMessagesIdRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.updateAnAutomatedMessage({ ...params }) -> Brevo.ConversationsMessage

#### 📝 Description

Update the text of an automated (pushed) message. The `text` and `html` fields of the message will be updated.

#### 🔌 Usage

```typescript await client.conversations.updateAnAutomatedMessage({ id: "id", text: "Your order has shipped! Here's your tracking number: 9114 5847 4668 7775 9233 54" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutConversationsPushedMessagesIdRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.deleteAnAutomatedMessage({ ...params }) -> void

#### 📝 Description

Delete an automated (pushed) message by its ID.

#### 🔌 Usage

```typescript await client.conversations.deleteAnAutomatedMessage({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteConversationsPushedMessagesIdRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

client.conversations.setVisitorGroupAssignment({ ...params }) -> Brevo.PutConversationsVisitorGroupResponse

#### 📝 Description

Assigns a visitor to a specific agent group or removes them from their current group.

#### 🔌 Usage

```typescript await client.conversations.setVisitorGroupAssignment({ groupId: "PjRBMhWGen6aRHjif" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PutConversationsVisitorGroupRequest`

**requestOptions:** `ConversationsClient.RequestOptions`

## Ecommerce

client.ecommerce.getCategories({ ...params }) -> Brevo.GetCategoriesResponse

#### 📝 Description

Retrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status. The response includes a `count` field with the total number of matching categories, and pagination defaults to 50 categories per page (maximum 100).

#### 🔌 Usage

```typescript await client.ecommerce.getCategories(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCategoriesRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.createUpdateCategory({ ...params }) -> Brevo.CreateUpdateCategoryResponse | undefined

#### 📝 Description

Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new category or `204` when an existing category is updated. The `name` field is mandatory for creation but optional for updates.

#### 🔌 Usage

```typescript await client.ecommerce.createUpdateCategory({ id: "CAT123" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateUpdateCategoryRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.createUpdateBatchCategory({ ...params }) -> Brevo.CreateUpdateBatchCategoryResponse

#### 📝 Description

Create or update multiple ecommerce categories in a single request. The `categories` array accepts up to 100 category objects, each requiring a unique `id`. When `updateEnabled` is `false` (the default), all categories are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing categories are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated categories.

#### 🔌 Usage

```typescript await client.ecommerce.createUpdateBatchCategory({ categories: [{ id: "CAT123" }] }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateUpdateBatchCategoryRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getCategoryInfo({ ...params }) -> Brevo.GetCategoryDetails

#### 📝 Description

Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a `404` error if no category matches the provided ID.

#### 🔌 Usage

```typescript await client.ecommerce.getCategoryInfo({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCategoryInfoRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.activateTheECommerceApp() -> void

#### 📝 Description

Getting access to Brevo eCommerce.

#### 🔌 Usage

```typescript await client.ecommerce.activateTheECommerceApp(); ```

#### ⚙️ Parameters

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows({ ...params }) -> Brevo.GetEcommerceAttributionMetricsResponse

#### 📝 Description

Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using `periodFrom` and `periodTo` in RFC3339 format. The response includes per-source metrics (orders count, revenue, and average basket) as well as aggregated totals across all requested sources.

#### 🔌 Usage

```typescript await client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows({ periodFrom: "2022-01-02T00:00:00Z", periodTo: "2022-01-03T00:00:00Z", "emailCampaignId[]": ["sale"] }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetEcommerceAttributionMetricsRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getDetailedAttributionMetricsForASingleBrevoCampaignOrWorkflow({ ...params }) -> Brevo.GetEcommerceAttributionMetricsConversionSourceConversionSourceIdResponse

#### 📝 Description

Retrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID. The response includes orders count, revenue, average basket value, and the number of new customers attributed to that specific campaign or workflow.

#### 🔌 Usage

```typescript await client.ecommerce.getDetailedAttributionMetricsForASingleBrevoCampaignOrWorkflow({ conversionSource: "email_campaign", conversionSourceId: "sale" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetEcommerceAttributionMetricsConversionSourceConversionSourceIdRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getAttributedProductSalesForASingleBrevoCampaignOrWorkflow({ ...params }) -> Brevo.GetEcommerceAttributionProductsConversionSourceConversionSourceIdResponse

#### 📝 Description

Retrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow. Each product entry includes its ID, name, SKU, image URL, product URL, price, revenue, and orders count. The conversion source type must be one of `email_campaign`, `sms_campaign`, `automation_workflow_email`, or `automation_workflow_sms`.

#### 🔌 Usage

```typescript await client.ecommerce.getAttributedProductSalesForASingleBrevoCampaignOrWorkflow({ conversionSource: "email_campaign", conversionSourceId: "sale" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetEcommerceAttributionProductsConversionSourceConversionSourceIdRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccount() -> Brevo.GetEcommerceConfigDisplayCurrencyResponse

#### 📝 Description

Retrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account. This currency is used to display monetary values across the ecommerce dashboard and reports. Returns a `403` error if ecommerce is not activated on the account.

#### 🔌 Usage

```typescript await client.ecommerce.getTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccount(); ```

#### ⚙️ Parameters

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.setConfigDisplayCurrency({ ...params }) -> Brevo.SetConfigDisplayCurrencyResponse

#### 📝 Description

Set or update the ISO 4217 display currency code for your Brevo ecommerce account. This currency determines how monetary values are displayed in the ecommerce dashboard and reports. The provided currency code must be a valid ISO 4217 code; invalid codes result in a `422` error. Returns a `403` error if ecommerce is not activated on the account.

#### 🔌 Usage

```typescript await client.ecommerce.setConfigDisplayCurrency({ code: "EUR" }); ```

#### ⚙️ Parameters

**request:** `Brevo.SetConfigDisplayCurrencyRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getOrders({ ...params }) -> unknown

#### 📝 Description

Get all the orders

#### 🔌 Usage

```typescript await client.ecommerce.getOrders(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetOrdersRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.createOrder({ ...params }) -> void

#### 📝 Description

Manages the transactional status of the order

#### 🔌 Usage

```typescript await client.ecommerce.createOrder({ amount: 308.42, createdAt: "2021-07-29T20:59:23.383Z", id: "14", products: [{ price: 99.99, productId: "P1" }], status: "completed", updatedAt: "2021-07-30T10:59:23.383Z" }); ```

#### ⚙️ Parameters

**request:** `Brevo.Order`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.createBatchOrder({ ...params }) -> Brevo.CreateBatchOrderResponse

#### 📝 Description

Create multiple orders at one time instead of one order at a time

#### 🔌 Usage

```typescript await client.ecommerce.createBatchOrder({ orders: [{ amount: 308.42, createdAt: "2021-07-29T20:59:23.383Z", id: "14", products: [{ price: 99.99, productId: "P1" }], status: "completed", updatedAt: "2021-07-30T10:59:23.383Z" }] }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateBatchOrderRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getProducts({ ...params }) -> Brevo.GetProductsResponse

#### 📝 Description

Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Use the `search` parameter to query across SKU, name, and ID simultaneously — results are prioritized as exact SKU match > SKU prefix match > name match > ID match. Pagination defaults to 50 products per page (maximum 1000), and the response includes a `count` field with the total number of matching products.

#### 🔌 Usage

```typescript await client.ecommerce.getProducts(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetProductsRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.createUpdateProduct({ ...params }) -> Brevo.CreateUpdateProductResponse | undefined

#### 📝 Description

Create a new ecommerce product or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is `false` (the default), the endpoint inserts a new product and returns `201`; if the product ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new product or `204` for an update. The `name` field is mandatory for creation but optional for updates. Product images are downloaded, validated (max 5 MB, formats: jpeg, jpg, png, bmp, gif, webp), and re-hosted on S3. The `metaInfo` object supports up to 20 keys with a cumulative size limit of approximately 1000 KB.

#### 🔌 Usage

```typescript await client.ecommerce.createUpdateProduct({ id: "P11", name: "Iphone 11" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateUpdateProductRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.createUpdateBatchProducts({ ...params }) -> Brevo.CreateUpdateBatchProductsResponse

#### 📝 Description

Create or update multiple ecommerce products in a single request. The `products` array accepts up to 100 product objects for creation (or up to 1000 when `updateEnabled` is `true` and the account has an increased limit). Each product requires a unique `id` and `name` (name is mandatory for creation only). When `updateEnabled` is `false`, all products are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing products are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated products.

#### 🔌 Usage

```typescript await client.ecommerce.createUpdateBatchProducts({ products: [{ id: "P11", name: "Iphone 11" }] }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateUpdateBatchProductsRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.getProductInfo({ ...params }) -> Brevo.GetProductDetails

#### 📝 Description

Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status. Returns a `404` error if no product matches the provided ID.

#### 🔌 Usage

```typescript await client.ecommerce.getProductInfo({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetProductInfoRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

client.ecommerce.createProductAlert({ ...params }) -> void

#### 📝 Description

Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`. Returns a `404` error if the product ID does not exist, and a `403` error if product alerts are not enabled for the account.

#### 🔌 Usage

```typescript await client.ecommerce.createProductAlert({ id: "id", type: "back_in_stock" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateProductAlertRequest`

**requestOptions:** `EcommerceClient.RequestOptions`

## Coupons

client.coupons.getCouponCollections({ ...params }) -> Brevo.GetCouponCollection

#### 📝 Description

Retrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).

#### 🔌 Usage

```typescript await client.coupons.getCouponCollections(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCouponCollectionsRequest`

**requestOptions:** `CouponsClient.RequestOptions`

client.coupons.createCouponCollection({ ...params }) -> Brevo.CreateCouponCollectionResponse

#### 📝 Description

Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number. The collection ID is auto-generated as a UUID and returned in the response.

#### 🔌 Usage

```typescript await client.coupons.createCouponCollection({ defaultCoupon: "Winter", name: "10%OFF" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateCouponCollectionRequest`

**requestOptions:** `CouponsClient.RequestOptions`

client.coupons.getCouponCollection({ ...params }) -> Brevo.GetCouponCollection

#### 📝 Description

Retrieve the details of a single coupon collection by its UUID. The response includes the collection name, default coupon value, total and remaining coupon counts, and creation timestamp. Returns a `404` error if no collection matches the provided ID.

#### 🔌 Usage

```typescript await client.coupons.getCouponCollection({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCouponCollectionRequest`

**requestOptions:** `CouponsClient.RequestOptions`

client.coupons.updateCouponCollection({ ...params }) -> Brevo.UpdateCouponCollectionResponse

#### 📝 Description

Update an existing coupon collection by its UUID. You can modify the default coupon value, set or remove the expiration date (pass `null` to remove), and configure or disable alert thresholds for remaining coupons or remaining days. Only the fields included in the request body are updated; omitted fields remain unchanged.

#### 🔌 Usage

```typescript await client.coupons.updateCouponCollection({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateCouponCollectionRequest`

**requestOptions:** `CouponsClient.RequestOptions`

client.coupons.createCoupons({ ...params }) -> void

#### 📝 Description

Add coupons to an existing coupon collection. The `coupons` array must contain between 1 and 10,000 unique coupon code strings, all associated with the specified `collectionId`. Coupon creation is processed asynchronously and a `204` status is returned immediately upon acceptance. Returns a `404` error if the specified coupon collection does not exist.

#### 🔌 Usage

```typescript await client.coupons.createCoupons({ collectionId: "23befbae-1505-47a8-bd27-e30ef739f32c", coupons: ["Uf12AF"] }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateCouponsRequest`

**requestOptions:** `CouponsClient.RequestOptions`

## Payments

client.payments.createPaymentRequest({ ...params }) -> Brevo.CreatePaymentRequestResponse

#### 📝 Description

Create a new payment request for a Brevo contact. The request requires a reference (displayed on the payment page), a contact ID, and a cart with currency and amount in cents. You can optionally configure a custom success redirect URL and enable email notifications with reminders. Returns the payment request ID and its public payment URL. A `403` error is returned if Brevo Payments is not activated or the account is not validated.

#### 🔌 Usage

```typescript await client.payments.createPaymentRequest({ cart: { currency: "EUR", specificAmount: 1200 }, contactId: 43, reference: "Invoice #INV0001" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreatePaymentRequestRequest`

**requestOptions:** `PaymentsClient.RequestOptions`

client.payments.getPaymentRequest({ ...params }) -> Brevo.GetPaymentRequestResponse

#### 📝 Description

Retrieve the details of a specific payment request by its ID. The response includes the reference, status (created, sent, reminderSent, or paid), cart details, notification configuration, contact ID, and the number of reminders sent. Returns a `404` error if no payment request matches the provided ID.

#### 🔌 Usage

```typescript await client.payments.getPaymentRequest({ id: "050db7b0-9bb7-4c1e-9c68-5a8dace8c1dc" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetPaymentRequestRequest`

**requestOptions:** `PaymentsClient.RequestOptions`

client.payments.deletePaymentRequest({ ...params }) -> void

#### 📝 Description

Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid. Returns a `404` error if no payment request matches the provided ID, and a `403` error if Brevo Payments is not activated or the account is not validated.

#### 🔌 Usage

```typescript await client.payments.deletePaymentRequest({ id: "9ae7d68a-565c-4695-9381-d8fb3e3a14cc" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeletePaymentRequestRequest`

**requestOptions:** `PaymentsClient.RequestOptions`

## Event

client.event.getEvents({ ...params }) -> Brevo.GetEventsList

#### 📝 Description

This endpoint currently only supports custom events. Retrieve a list of events filtered by various criteria.

#### 🔌 Usage

```typescript await client.event.getEvents(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetEventsRequest`

**requestOptions:** `EventClient.RequestOptions`

client.event.createEvent({ ...params }) -> void

#### 📝 Description

Create an event to track a contact's interaction.

#### 🔌 Usage

```typescript await client.event.createEvent({ event_name: "video_played", identifiers: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateEventRequest`

**requestOptions:** `EventClient.RequestOptions`

client.event.createBatchEvents({ ...params }) -> Brevo.BatchAcceptedResponse

#### 📝 Description

Create multiple events to track contacts' interactions in a single request.

#### 🔌 Usage

```typescript await client.event.createBatchEvents({ events: [{ event_name: "order_created", identifiers: {} }] }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateBatchEventsRequest`

**requestOptions:** `EventClient.RequestOptions`

## InboundParsing

client.inboundParsing.getInboundEmailEvents({ ...params }) -> Brevo.GetInboundEmailEventsResponse

#### 📝 Description

This endpoint will show the list of all the events for the received emails. When no date range is provided, the last 30 days of events are returned by default.

#### 🔌 Usage

```typescript await client.inboundParsing.getInboundEmailEvents(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetInboundEmailEventsRequest`

**requestOptions:** `InboundParsingClient.RequestOptions`

client.inboundParsing.getInboundEmailEventsByUuid({ ...params }) -> Brevo.GetInboundEmailEventsByUuidResponse

#### 📝 Description

This endpoint will show the list of all events history for one particular received email.

#### 🔌 Usage

```typescript await client.inboundParsing.getInboundEmailEventsByUuid({ uuid: "uuid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetInboundEmailEventsByUuidRequest`

**requestOptions:** `InboundParsingClient.RequestOptions`

client.inboundParsing.getInboundEmailAttachment({ ...params }) -> core.BinaryResponse

#### 📝 Description

This endpoint will retrieve inbound attachment with download token.

#### 🔌 Usage

```typescript await client.inboundParsing.getInboundEmailAttachment({ downloadToken: "downloadToken" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetInboundEmailAttachmentRequest`

**requestOptions:** `InboundParsingClient.RequestOptions`

## Balance

client.balance.getActiveBalancesApi({ ...params }) -> Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceResponse

#### 📝 Description

Returns Active Balances

#### 🔌 Usage

```typescript await client.balance.getActiveBalancesApi({ pid: "pid", contactId: 1000000, balanceDefinitionId: "balanceDefinitionId" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.getBalanceDefinitionList({ ...params }) -> Brevo.GetBalanceDefinitionListResponse | undefined

#### 📝 Description

Returns balance definition page

#### 🔌 Usage

```typescript await client.balance.getBalanceDefinitionList({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetBalanceDefinitionListRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.createBalanceDefinition({ ...params }) -> Brevo.BalanceDefinition

#### 📝 Description

Creates balance definition and returns information

#### 🔌 Usage

```typescript await client.balance.createBalanceDefinition({ pid: "pid", name: "name", unit: "POINTS" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.getBalanceDefinition({ ...params }) -> Brevo.BalanceDefinition

#### 📝 Description

Returns balance definition

#### 🔌 Usage

```typescript await client.balance.getBalanceDefinition({ pid: "pid", bdid: "bdid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetBalanceDefinitionRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.updateBalanceDefinition({ ...params }) -> Brevo.BalanceDefinition

#### 📝 Description

Updates Balance definition

#### 🔌 Usage

```typescript await client.balance.updateBalanceDefinition({ pid: "pid", bdid: "bdid", name: "name", unit: "POINTS" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateBalanceDefinitionRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.deleteBalanceDefinition({ ...params }) -> void

#### 📝 Description

Delete Balance definition

#### 🔌 Usage

```typescript await client.balance.deleteBalanceDefinition({ pid: "pid", bdid: "bdid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteBalanceDefinitionRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.createBalanceLimit({ ...params }) -> Brevo.BalanceLimit

#### 📝 Description

Creates balance limit and sends the created UUID along with the data

#### 🔌 Usage

```typescript await client.balance.createBalanceLimit({ pid: "pid", bdid: "bdid", constraintType: "transaction", durationUnit: "day", durationValue: 1, transactionType: "credit", value: 1 }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateBalanceLimitRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.getBalanceLimit({ ...params }) -> Brevo.BalanceLimit

#### 📝 Description

Fetches balance limits and send the created UUID along with the data

#### 🔌 Usage

```typescript await client.balance.getBalanceLimit({ pid: "pid", bdid: "bdid", blid: "blid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetBalanceLimitRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.updateBalanceLimit({ ...params }) -> Brevo.BalanceLimit

#### 📝 Description

Updates balance limit

#### 🔌 Usage

```typescript await client.balance.updateBalanceLimit({ pid: "pid", bdid: "bdid", blid: "blid", constraintType: "transaction", durationUnit: "day", durationValue: 1, transactionType: "credit", value: 1 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateBalanceLimitRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.deleteBalanceLimit({ ...params }) -> void

#### 📝 Description

Delete balance limit

#### 🔌 Usage

```typescript await client.balance.deleteBalanceLimit({ pid: "pid", bdid: "bdid", blid: "blid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteBalanceLimitRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.getContactBalances({ ...params }) -> Brevo.GetContactBalancesResponse

#### 📝 Description

Returns contact balances for a given balance definition across all subscriptions.

#### 🔌 Usage

```typescript await client.balance.getContactBalances({ pid: "pid", balanceDefinitionId: "balanceDefinitionId" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetContactBalancesRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.createBalanceOrder({ ...params }) -> Brevo.CreateBalanceOrderResponse

#### 📝 Description

Returns created order

#### 🔌 Usage

```typescript await client.balance.createBalanceOrder({ pid: "pid", amount: 1.1, balanceDefinitionId: "balanceDefinitionId", contactId: 1, dueAt: "dueAt", source: "engine" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateBalanceOrderRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.getSubscriptionBalances({ ...params }) -> Brevo.GetSubscriptionBalancesResponse

#### 📝 Description

Returns subscription balances

#### 🔌 Usage

```typescript await client.balance.getSubscriptionBalances({ pid: "pid", cid: "cid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSubscriptionBalancesRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.createSubscriptionBalances({ ...params }) -> Brevo.PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse

#### 📝 Description

Creates a balance for a contact

#### 🔌 Usage

```typescript await client.balance.createSubscriptionBalances({ pid: "pid", cid: "cid", balanceDefinitionId: "balanceDefinitionId" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.getTransactionHistoryApi({ ...params }) -> Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryResponse

#### 📝 Description

Returns transaction history

#### 🔌 Usage

```typescript await client.balance.getTransactionHistoryApi({ pid: "pid", contactId: 1000000, balanceDefinitionId: "balanceDefinitionId" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.beginTransaction({ ...params }) -> Brevo.Transaction

#### 📝 Description

Creates new transaction and returns information

#### 🔌 Usage

```typescript await client.balance.beginTransaction({ pid: "pid", amount: 1.1, balanceDefinitionId: "balanceDefinitionId" }); ```

#### ⚙️ Parameters

**request:** `Brevo.BeginTransactionRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.cancelTransaction({ ...params }) -> Brevo.Transaction

#### 📝 Description

Cancels transaction

#### 🔌 Usage

```typescript await client.balance.cancelTransaction({ pid: "pid", tid: "tid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CancelTransactionRequest`

**requestOptions:** `BalanceClient.RequestOptions`

client.balance.completeTransaction({ ...params }) -> Brevo.Transaction

#### 📝 Description

Completes transaction

#### 🔌 Usage

```typescript await client.balance.completeTransaction({ pid: "pid", tid: "tid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CompleteTransactionRequest`

**requestOptions:** `BalanceClient.RequestOptions`

## Program

client.program.getLpList({ ...params }) -> Brevo.GetLpListResponse

#### 📝 Description

Returns list of loyalty programs

#### 🔌 Usage

```typescript await client.program.getLpList(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLpListRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.createNewLp({ ...params }) -> Brevo.LoyaltyProgram

#### 📝 Description

Creates loyalty program

#### 🔌 Usage

```typescript await client.program.createNewLp({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateNewLpRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.getLoyaltyProgramInfo({ ...params }) -> Brevo.LoyaltyProgram

#### 📝 Description

Returns loyalty program

#### 🔌 Usage

```typescript await client.program.getLoyaltyProgramInfo({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLoyaltyProgramInfoRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.updateLoyaltyProgram({ ...params }) -> Brevo.LoyaltyProgram

#### 📝 Description

Updates loyalty program

#### 🔌 Usage

```typescript await client.program.updateLoyaltyProgram({ pid: "pid", name: "name" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateLoyaltyProgramRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.deleteLoyaltyProgram({ ...params }) -> void

#### 📝 Description

Deletes Loyalty Program

#### 🔌 Usage

```typescript await client.program.deleteLoyaltyProgram({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteLoyaltyProgramRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.partiallyUpdateLoyaltyProgram({ ...params }) -> Brevo.LoyaltyProgram

#### 📝 Description

Partially updates loyalty program

#### 🔌 Usage

```typescript await client.program.partiallyUpdateLoyaltyProgram({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PartiallyUpdateLoyaltyProgramRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.getParameterSubscriptionInfo({ ...params }) -> Brevo.GetParameterSubscriptionInfoResponse

#### 📝 Description

Get Information of balances, tiers, rewards and subscription members for a subscription

#### 🔌 Usage

```typescript await client.program.getParameterSubscriptionInfo({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetParameterSubscriptionInfoRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.deleteContactSubscription({ ...params }) -> void

#### 📝 Description

Delete subscription for a contact

#### 🔌 Usage

```typescript await client.program.deleteContactSubscription({ pid: "pid", cid: 1 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteContactSubscriptionRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.publishLoyaltyProgram({ ...params }) -> void

#### 📝 Description

Publishes loyalty program

#### 🔌 Usage

```typescript await client.program.publishLoyaltyProgram({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PublishLoyaltyProgramRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.subscribeMemberToASubscription({ ...params }) -> Brevo.SubscribeMemberToASubscriptionResponse

#### 📝 Description

Add member to a subscription

#### 🔌 Usage

```typescript await client.program.subscribeMemberToASubscription({ pid: "pid", memberContactIds: [1] }); ```

#### ⚙️ Parameters

**request:** `Brevo.SubscribeMemberToASubscriptionRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.deleteContactMembers({ ...params }) -> void

#### 📝 Description

Deletes member from a subscription

#### 🔌 Usage

```typescript await client.program.deleteContactMembers({ pid: "pid", memberContactIds: "memberContactIds" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteContactMembersRequest`

**requestOptions:** `ProgramClient.RequestOptions`

client.program.subscribeToLoyaltyProgram({ ...params }) -> Brevo.SubscribeToLoyaltyProgramResponse

#### 📝 Description

Subscribes to a loyalty program

#### 🔌 Usage

```typescript await client.program.subscribeToLoyaltyProgram({ pid: "pid", contactId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.SubscribeToLoyaltyProgramRequest`

**requestOptions:** `ProgramClient.RequestOptions`

## Reward

client.reward.getCodeCount({ ...params }) -> Brevo.GetCodeCountResponse

#### 📝 Description

Get code count

#### 🔌 Usage

```typescript await client.reward.getCodeCount({ pid: "pid", cpid: "cpid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCodeCountRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.getRewardPageApi({ ...params }) -> Brevo.GetLoyaltyOfferProgramsPidOffersResponse

#### 📝 Description

Returns a reward page

#### 🔌 Usage

```typescript await client.reward.getRewardPageApi({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLoyaltyOfferProgramsPidOffersRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.createReward({ ...params }) -> Brevo.CreateRewardResponse

#### 📝 Description

Creates a new reward in the loyalty program.

#### 🔌 Usage

```typescript await client.reward.createReward({ pid: "pid", name: "name" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateRewardRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.createVoucher({ ...params }) -> Brevo.CreateVoucherResponse

#### 📝 Description

Create a voucher and attribute it to a specific membership.

#### 🔌 Usage

```typescript await client.reward.createVoucher({ pid: "pid", rewardId: "rewardId" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateVoucherRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.redeemVoucher({ ...params }) -> Brevo.Redeem

#### 📝 Description

Creates a request to redeem a voucher.

#### 🔌 Usage

```typescript await client.reward.redeemVoucher({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.RedeemVoucherRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.completeRedeemTransaction({ ...params }) -> Brevo.Redeem

#### 📝 Description

Completes voucher redeem request.

#### 🔌 Usage

```typescript await client.reward.completeRedeemTransaction({ pid: "pid", tid: "tid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CompleteRedeemTransactionRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.revokeVouchers({ ...params }) -> void

#### 📝 Description

Revoke attributed vouchers.

#### 🔌 Usage

```typescript await client.reward.revokeVouchers({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.RevokeVouchersRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.validateReward({ ...params }) -> Brevo.ValidateRewardResponse

#### 📝 Description

Validates a reward.

#### 🔌 Usage

```typescript await client.reward.validateReward({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.ValidateRewardRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.getRewardInformation({ ...params }) -> Brevo.GetLoyaltyOfferProgramsPidRewardsRidResponse

#### 📝 Description

Returns reward information.

#### 🔌 Usage

```typescript await client.reward.getRewardInformation({ pid: "pid", rid: "rid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLoyaltyOfferProgramsPidRewardsRidRequest`

**requestOptions:** `RewardClient.RequestOptions`

client.reward.getVoucherForAContact({ ...params }) -> Brevo.GetLoyaltyOfferProgramsPidVouchersResponse

#### 📝 Description

Get voucher for a contact

#### 🔌 Usage

```typescript await client.reward.getVoucherForAContact({ pid: "pid", contactId: 1 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLoyaltyOfferProgramsPidVouchersRequest`

**requestOptions:** `RewardClient.RequestOptions`

## Tier

client.tier.addSubscriptionToTier({ ...params }) -> Brevo.AddSubscriptionToTierResponse

#### 📝 Description

Manually assigns a tier to a specific membership.

#### 🔌 Usage

```typescript await client.tier.addSubscriptionToTier({ pid: "pid", cid: "cid", tid: "tid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.AddSubscriptionToTierRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.getListOfTierGroups({ ...params }) -> Brevo.GetListOfTierGroupsResponse

#### 📝 Description

Returns the list of tier groups defined within the loyalty program.

#### 🔌 Usage

```typescript await client.tier.getListOfTierGroups({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetListOfTierGroupsRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.createTierGroup({ ...params }) -> Brevo.TierGroup

#### 📝 Description

Creates a new tier group in a loyalty program. *(The changes will take effect with the next publication of the loyalty program)*

#### 🔌 Usage

```typescript await client.tier.createTierGroup({ pid: "pid", name: "name" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateTierGroupRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.getTierGroup({ ...params }) -> Brevo.TierGroup

#### 📝 Description

Returns tier group information.

#### 🔌 Usage

```typescript await client.tier.getTierGroup({ pid: "pid", gid: "gid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetTierGroupRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.updateTierGroup({ ...params }) -> Brevo.TierGroup

#### 📝 Description

Updates a tier group from a loyalty program. *(The changes will take effect with the next publication of the loyalty program)*

#### 🔌 Usage

```typescript await client.tier.updateTierGroup({ pid: "pid", gid: "gid", downgradeStrategy: "real_time", name: "name", tierOrder: ["tierOrder"], upgradeStrategy: "real_time" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateTierGroupRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.deleteTierGroup({ ...params }) -> void

#### 📝 Description

Deletes a tier group from a loyalty program. *(The changes will take effect with the next publication of the loyalty program)*

#### 🔌 Usage

```typescript await client.tier.deleteTierGroup({ pid: "pid", gid: "gid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteTierGroupRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.createTierForTierGroup({ ...params }) -> Brevo.Tier

#### 📝 Description

Creates a new tier in a loyalty program tier group. *(The changes will take effect with the next publication of the loyalty program)*

#### 🔌 Usage

```typescript await client.tier.createTierForTierGroup({ pid: "pid", gid: "gid", accessConditions: [{}], name: "name" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateTierForTierGroupRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.getLoyaltyProgramTier({ ...params }) -> Brevo.GetLoyaltyProgramTierResponse

#### 📝 Description

Returns the list of tiers defined within the loyalty program.

#### 🔌 Usage

```typescript await client.tier.getLoyaltyProgramTier({ pid: "pid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetLoyaltyProgramTierRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.updateTier({ ...params }) -> Brevo.Tier

#### 📝 Description

Modifies an existing tier for the specified tier group *(The changes will take effect with the next publication of the loyalty program)*

#### 🔌 Usage

```typescript await client.tier.updateTier({ pid: "pid", tid: "tid", accessConditions: [{}], name: "name", tierRewards: [{}] }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateTierRequest`

**requestOptions:** `TierClient.RequestOptions`

client.tier.deleteTier({ ...params }) -> void

#### 📝 Description

Deletes a tier from a loyalty program tier group. *(The changes will take effect with the next publication of the loyalty program)*

#### 🔌 Usage

```typescript await client.tier.deleteTier({ pid: "pid", tid: "tid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteTierRequest`

**requestOptions:** `TierClient.RequestOptions`

## Wallet

client.wallet.getWalletPassInstallUrl({ ...params }) -> Brevo.WalletPassInstallUrl

#### 📝 Description

Generate a wallet installation URL for a specific contact. The returned URL points to the pass installation page and encodes the pass, contact and organization identifiers as an encrypted token, so it can be shared with the contact (email, SMS, QR code, ...) to add the pass to their Apple Wallet or Google Wallet.

#### 🔌 Usage

```typescript await client.wallet.getWalletPassInstallUrl({ passId: "passId", contactId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetWalletPassInstallUrlRequest`

**requestOptions:** `WalletClient.RequestOptions`

## EmailCampaigns

client.emailCampaigns.getEmailCampaigns({ ...params }) -> Brevo.GetEmailCampaignsResponse

#### 📝 Description

The response payload for this endpoint has changed You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/2023/2/7).

#### 🔌 Usage

```typescript await client.emailCampaigns.getEmailCampaigns(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetEmailCampaignsRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.createEmailCampaign({ ...params }) -> Brevo.CreateEmailCampaignResponse

#### 📝 Description

Create a new email campaign. The campaign requires at minimum a name and sender details, and is created in draft status by default. You must provide email content via one of three mutually exclusive options: htmlContent (inline HTML), htmlUrl (remote URL), or templateId (existing template); additionally, A/B testing can be enabled by setting abTesting to true with subjectA and subjectB, but this is incompatible with sendAtBestTime.

#### 🔌 Usage

```typescript await client.emailCampaigns.createEmailCampaign({ name: "Newsletter - May 2017", sender: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateEmailCampaignRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.uploadImageToGallery({ ...params }) -> Brevo.UploadImageToGalleryResponse

#### 📝 Description

Upload an image to your account''s image gallery by providing an absolute URL to the image. The maximum allowed image size is 2MB and supported formats are jpeg, jpg, png, bmp, and gif; local file uploads are not supported.

#### 🔌 Usage

```typescript await client.emailCampaigns.uploadImageToGallery({ imageUrl: "https://somedomain.com/image1.jpg" }); ```

#### ⚙️ Parameters

**request:** `Brevo.UploadImageToGalleryRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.getEmailCampaign({ ...params }) -> Brevo.GetEmailCampaignResponse

#### 📝 Description

Retrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content. Use the statistics query parameter to select which statistics to include (globalStats, linksStats, statsByDomain, statsByDevice, or statsByBrowser); statsByDevice and statsByBrowser are only available on this single-campaign endpoint. You can exclude HTML content from the response by setting excludeHtmlContent to true.

#### 🔌 Usage

```typescript await client.emailCampaigns.getEmailCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetEmailCampaignRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.updateEmailCampaign({ ...params }) -> void

#### 📝 Description

Update an existing email campaign''s properties such as name, subject, content, sender, recipients, schedule, and A/B testing configuration. The campaign must exist and the request body must contain at least one valid field to update. Only draft or scheduled campaigns can be modified; if sendAtBestTime is enabled, IP warmup will be automatically disabled.

#### 🔌 Usage

```typescript await client.emailCampaigns.updateEmailCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateEmailCampaignRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.deleteEmailCampaign({ ...params }) -> void

#### 📝 Description

Delete an email campaign by its campaign ID. Only campaigns that have not been scheduled can be deleted; attempting to delete a campaign that has already been scheduled will return a 403 permission denied error. Related data in templates, newsletter builder, and schedule collections is also cleaned up.

#### 🔌 Usage

```typescript await client.emailCampaigns.deleteEmailCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteEmailCampaignRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.getAbTestCampaignResult({ ...params }) -> Brevo.GetAbTestCampaignResultResponse

#### 📝 Description

Obtain winning version of an A/B test email campaign

#### 🔌 Usage

```typescript await client.emailCampaigns.getAbTestCampaignResult({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetAbTestCampaignResultRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.emailExportRecipients({ ...params }) -> Brevo.EmailExportRecipientsResponse

#### 📝 Description

Export the recipients of a sent email campaign as an asynchronous process, filtered by recipient type (e.g. openers, clickers, hardBounces). The recipientsType field is required and determines which subset of recipients to export. An optional notifyURL webhook will be called once the export is complete, and the response returns a processId to track the export status.

#### 🔌 Usage

```typescript await client.emailCampaigns.emailExportRecipients({ campaignId: 1000000, recipientsType: "all" }); ```

#### ⚙️ Parameters

**request:** `Brevo.EmailExportRecipientsRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.sendEmailCampaignNow({ ...params }) -> void

#### 📝 Description

Send an existing email campaign immediately by scheduling it for the current time. The campaign must have valid recipients and content configured before sending. The system verifies your account''s send limit and credit balance before dispatching; if credits are insufficient, a 402 error is returned.

#### 🔌 Usage

```typescript await client.emailCampaigns.sendEmailCampaignNow({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendEmailCampaignNowRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.sendReport({ ...params }) -> void

#### 📝 Description

A PDF will be sent to the specified email addresses

#### 🔌 Usage

```typescript await client.emailCampaigns.sendReport({ campaignId: 1000000, body: { email: { body: "Please find attached the report of our last email campaign.", to: ["jim.suehan@example.com"] } } }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendReportRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.sendTestEmail({ ...params }) -> void

#### 📝 Description

Send a test version of an email campaign to specified email addresses or your entire test list. If the emailTo array is left empty, the test mail will be sent to all addresses in your test list. You can send a maximum of 50 test emails per day.

#### 🔌 Usage

```typescript await client.emailCampaigns.sendTestEmail({ campaignId: 1000000, body: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendTestEmailRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.getSharedTemplateUrl({ ...params }) -> Brevo.GetSharedTemplateUrlResponse

#### 📝 Description

Get a unique URL to share & import an email template from one Brevo account to another.

#### 🔌 Usage

```typescript await client.emailCampaigns.getSharedTemplateUrl({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSharedTemplateUrlRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

client.emailCampaigns.updateCampaignStatus({ ...params }) -> void

#### 📝 Description

Update the status of an email campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.

#### 🔌 Usage

```typescript await client.emailCampaigns.updateCampaignStatus({ campaignId: 1000000, body: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateCampaignStatusRequest`

**requestOptions:** `EmailCampaignsClient.RequestOptions`

## SmsCampaigns

client.smsCampaigns.getSmsCampaigns({ ...params }) -> Brevo.GetSmsCampaignsResponse

#### 📝 Description

Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.

#### 🔌 Usage

```typescript await client.smsCampaigns.getSmsCampaigns(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSmsCampaignsRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.createSmsCampaign({ ...params }) -> Brevo.CreateSmsCampaignResponse

#### 📝 Description

Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.

#### 🔌 Usage

```typescript await client.smsCampaigns.createSmsCampaign({ content: "Get a discount by visiting our NY store and saying : Happy Spring!", name: "Spring Promo Code", sender: "MyShop" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateSmsCampaignRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.getSmsCampaign({ ...params }) -> Brevo.GetSmsCampaignResponse

#### 📝 Description

Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.

#### 🔌 Usage

```typescript await client.smsCampaigns.getSmsCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSmsCampaignRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.updateSmsCampaign({ ...params }) -> void

#### 📝 Description

Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.

#### 🔌 Usage

```typescript await client.smsCampaigns.updateSmsCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateSmsCampaignRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.deleteSmsCampaign({ ...params }) -> void

#### 📝 Description

Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.

#### 🔌 Usage

```typescript await client.smsCampaigns.deleteSmsCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteSmsCampaignRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.requestSmsRecipientExport({ ...params }) -> Brevo.RequestSmsRecipientExportResponse

#### 📝 Description

It returns the background process ID which on completion calls the notify URL that you have set in the input.

#### 🔌 Usage

```typescript await client.smsCampaigns.requestSmsRecipientExport({ campaignId: 1000000, recipientsType: "all" }); ```

#### ⚙️ Parameters

**request:** `Brevo.RequestSmsRecipientExportRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.sendSmsCampaignNow({ ...params }) -> void

#### 📝 Description

Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account''s SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned. The campaign must have valid recipients and content already configured.

#### 🔌 Usage

```typescript await client.smsCampaigns.sendSmsCampaignNow({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendSmsCampaignNowRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.sendSmsReport({ ...params }) -> void

#### 📝 Description

Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.

#### 🔌 Usage

```typescript await client.smsCampaigns.sendSmsReport({ campaignId: 1000000, body: { email: { body: "Please find attached the report of our last email campaign.", to: ["jim.suehan@example.com"] } } }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendSmsReportRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.sendTestSms({ ...params }) -> void

#### 📝 Description

Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).

#### 🔌 Usage

```typescript await client.smsCampaigns.sendTestSms({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendTestSmsRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

client.smsCampaigns.updateSmsCampaignStatus({ ...params }) -> void

#### 📝 Description

Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.

#### 🔌 Usage

```typescript await client.smsCampaigns.updateSmsCampaignStatus({ campaignId: 1000000, body: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateSmsCampaignStatusRequest`

**requestOptions:** `SmsCampaignsClient.RequestOptions`

## WhatsAppCampaigns

client.whatsAppCampaigns.getWhatsAppCampaigns({ ...params }) -> Brevo.GetWhatsAppCampaignsResponse

#### 📝 Description

Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.getWhatsAppCampaigns(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetWhatsAppCampaignsRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.createWhatsAppCampaign({ ...params }) -> Brevo.CreateWhatsAppCampaignResponse

#### 📝 Description

You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below. [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information. [Get all the Lists](https://developers.brevo.com/reference/getlists-1) [Get all the Segments](https://developers.brevo.com/reference/getsegments)

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.createWhatsAppCampaign({ name: "Test Campaign", recipients: {}, scheduledAt: "2017-06-01T12:30:00+02:00", templateId: 19 }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateWhatsAppCampaignRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.getWhatsAppConfig() -> Brevo.GetWhatsAppConfigResponse

#### 📝 Description

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.getWhatsAppConfig(); ```

#### ⚙️ Parameters

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.createWhatsAppTemplate({ ...params }) -> Brevo.CreateWhatsAppTemplateResponse

#### 📝 Description

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.createWhatsAppTemplate({ bodyText: "making it look like readable English", category: "MARKETING", language: "en", name: "Test template" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateWhatsAppTemplateRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.getWhatsAppTemplates({ ...params }) -> Brevo.GetWhatsAppTemplatesResponse

#### 📝 Description

Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.getWhatsAppTemplates(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetWhatsAppTemplatesRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.sendWhatsAppTemplateApproval({ ...params }) -> void

#### 📝 Description

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.sendWhatsAppTemplateApproval({ templateId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendWhatsAppTemplateApprovalRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.getWhatsAppCampaign({ ...params }) -> Brevo.GetWhatsAppCampaignResponse

#### 📝 Description

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.getWhatsAppCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetWhatsAppCampaignRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.updateWhatsAppCampaign({ ...params }) -> void

#### 📝 Description

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.updateWhatsAppCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateWhatsAppCampaignRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

client.whatsAppCampaigns.deleteWhatsAppCampaign({ ...params }) -> void

#### 📝 Description

Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.

#### 🔌 Usage

```typescript await client.whatsAppCampaigns.deleteWhatsAppCampaign({ campaignId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteWhatsAppCampaignRequest`

**requestOptions:** `WhatsAppCampaignsClient.RequestOptions`

## Companies

client.companies.getAllCompanies({ ...params }) -> Brevo.GetCompaniesResponse

#### 📝 Description

Retrieve a paginated list of companies with optional filtering, sorting, and search capabilities. Results are sorted by creation date in descending order by default, and can be filtered by attributes, linked contacts, linked deals, or modification/creation timestamps.

#### 🔌 Usage

```typescript await client.companies.getAllCompanies(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCompaniesRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.createACompany({ ...params }) -> Brevo.PostCompaniesResponse

#### 📝 Description

Create a new CRM company with the specified name, attributes, and optional associations to contacts and deals. The company name is required, and you can optionally provide a country code when a phone number attribute is included.

#### 🔌 Usage

```typescript await client.companies.createACompany({ name: "company" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCompaniesRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.importCompaniesCreationAndUpdation({ ...params }) -> Brevo.PostCompaniesImportResponse

#### 📝 Description

Import companies from a CSV file with mapping options.

#### 🔌 Usage

```typescript await client.companies.importCompaniesCreationAndUpdation({}); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCompaniesImportRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.linkAndUnlinkCompanyWithContactAndDeal({ ...params }) -> void

#### 📝 Description

Link or unlink contacts and deals with a specific company in a single request. You can simultaneously link new contacts/deals and unlink existing ones by providing the respective ID arrays in the request body.

#### 🔌 Usage

```typescript await client.companies.linkAndUnlinkCompanyWithContactAndDeal({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PatchCompaniesLinkUnlinkIdRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.getACompany({ ...params }) -> Brevo.Company

#### 📝 Description

Retrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals. Returns a 404 error if the company does not exist, or a 403 error if the user lacks permission to view the company.

#### 🔌 Usage

```typescript await client.companies.getACompany({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCompaniesIdRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.deleteACompany({ ...params }) -> void

#### 📝 Description

Permanently delete a company by its identifier. The requesting user must be the company owner or have manage permission on companies; otherwise, a 403 Forbidden error is returned.

#### 🔌 Usage

```typescript await client.companies.deleteACompany({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCompaniesIdRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.updateACompany({ ...params }) -> Brevo.Company

#### 📝 Description

Update an existing company''s attributes, name, linked contacts, or linked deals. Note that passing `linkedContactsIds` or `linkedDealsIds` replaces the entire list of associations, so omitted IDs will be removed. The company name cannot be set to an empty string.

#### 🔌 Usage

```typescript await client.companies.updateACompany({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PatchCompaniesIdRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.createACompanyDealAttribute({ ...params }) -> Brevo.PostCrmAttributesResponse

#### 📝 Description

Create a new custom attribute for companies or deals. The attribute label must be unique within the object type, cannot exceed 50 characters, and cannot use reserved names. For `single-select` or `multi-choice` attribute types, you must also provide the `optionsLabels` array.

#### 🔌 Usage

```typescript await client.companies.createACompanyDealAttribute({ attributeType: "text", label: "Attribute Label", objectType: "companies" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCrmAttributesRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.deleteAnAttribute({ ...params }) -> void

#### 📝 Description

Delete an existing custom attribute by its identifier. This permanently removes the attribute definition and cleans up all references to it across companies or deals. System-default and non-editable attributes cannot be deleted.

#### 🔌 Usage

```typescript await client.companies.deleteAnAttribute({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCrmAttributesIdRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.updateAnAttribute({ ...params }) -> void

#### 📝 Description

Update an existing custom attribute''s label or options. You can rename the attribute label or modify the available options for `single-select` and `multi-choice` attribute types. System-default attributes cannot be modified except for specific editable fields.

#### 🔌 Usage

```typescript await client.companies.updateAnAttribute({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PatchCrmAttributesIdRequest`

**requestOptions:** `CompaniesClient.RequestOptions`

client.companies.getCompanyAttributes() -> Brevo.GetCrmAttributesCompaniesResponseItem[]

#### 📝 Description

Retrieve the list of all attributes defined for companies, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.

#### 🔌 Usage

```typescript await client.companies.getCompanyAttributes(); ```

#### ⚙️ Parameters

**requestOptions:** `CompaniesClient.RequestOptions`

## Deals

client.deals.getDealAttributes() -> Brevo.GetCrmAttributesDealsResponseItem[]

#### 📝 Description

Retrieve the list of all attributes defined for deals, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.

#### 🔌 Usage

```typescript await client.deals.getDealAttributes(); ```

#### ⚙️ Parameters

**requestOptions:** `DealsClient.RequestOptions`

client.deals.getAllDeals({ ...params }) -> Brevo.GetCrmDealsResponse

#### 📝 Description

Retrieve a paginated list of deals with optional filtering, sorting, and search capabilities. Results can be filtered by attributes such as deal name or owner, linked companies, linked contacts, or modification/creation timestamps. Default sort order is descending by creation date.

#### 🔌 Usage

```typescript await client.deals.getAllDeals(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmDealsRequest`

**requestOptions:** `DealsClient.RequestOptions`

client.deals.createADeal({ ...params }) -> Brevo.PostCrmDealsResponse

#### 📝 Description

Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies. You can assign the deal to a specific pipeline and stage by providing `pipeline` and `deal_stage` attribute IDs, which can be retrieved from the pipeline details endpoint.

#### 🔌 Usage

```typescript await client.deals.createADeal({ name: "Deal: Connect with company" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCrmDealsRequest`

**requestOptions:** `DealsClient.RequestOptions`

client.deals.importDealsCreationAndUpdation({ ...params }) -> Brevo.PostCrmDealsImportResponse

#### 📝 Description

Import deals from a CSV file with mapping options.

#### 🔌 Usage

```typescript await client.deals.importDealsCreationAndUpdation({}); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCrmDealsImportRequest`

**requestOptions:** `DealsClient.RequestOptions`

client.deals.linkAndUnlinkADealWithContactsAndCompanies({ ...params }) -> void

#### 📝 Description

Link or unlink contacts and companies with a specific deal in a single request. You can simultaneously link new contacts/companies and unlink existing ones by providing the respective ID arrays in the request body.

#### 🔌 Usage

```typescript await client.deals.linkAndUnlinkADealWithContactsAndCompanies({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PatchCrmDealsLinkUnlinkIdRequest`

**requestOptions:** `DealsClient.RequestOptions`

client.deals.getADeal({ ...params }) -> Brevo.Deal

#### 📝 Description

Retrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, linked contacts, and linked companies. Returns a 404 error if the deal does not exist.

#### 🔌 Usage

```typescript await client.deals.getADeal({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmDealsIdRequest`

**requestOptions:** `DealsClient.RequestOptions`

client.deals.deleteADeal({ ...params }) -> void

#### 📝 Description

Permanently delete a deal by its identifier. The requesting user must be the deal owner or have manage permission on deals; otherwise, a 403 Forbidden error is returned.

#### 🔌 Usage

```typescript await client.deals.deleteADeal({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCrmDealsIdRequest`

**requestOptions:** `DealsClient.RequestOptions`

client.deals.updateADeal({ ...params }) -> void

#### 📝 Description

Update an existing deal''s attributes, name, linked contacts, or linked companies. Note that passing `linkedContactsIds` or `linkedCompaniesIds` replaces the entire list of associations, so omitted IDs will be removed. To move a deal to a different pipeline or stage, provide both the `pipeline` and `deal_stage` attribute IDs.

#### 🔌 Usage

```typescript await client.deals.updateADeal({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PatchCrmDealsIdRequest`

**requestOptions:** `DealsClient.RequestOptions`

client.deals.getPipelineStages() -> Brevo.Pipeline

#### 📝 Description

This endpoint is deprecated. Prefer /crm/pipeline/details/{pipelineID} instead.

#### 🔌 Usage

```typescript await client.deals.getPipelineStages(); ```

#### ⚙️ Parameters

**requestOptions:** `DealsClient.RequestOptions`

client.deals.getAllPipelines() -> Brevo.Pipelines

#### 📝 Description

Retrieve the list of all deal pipelines configured for your account, including each pipeline''s stages and settings. If no pipelines have been configured yet, a default pipeline is automatically created and returned.

#### 🔌 Usage

```typescript await client.deals.getAllPipelines(); ```

#### ⚙️ Parameters

**requestOptions:** `DealsClient.RequestOptions`

client.deals.getAPipeline({ ...params }) -> Brevo.Pipelines

#### 📝 Description

Retrieve the details of a specific deal pipeline by its identifier, including its stages, stage ordering, and configuration. Use this endpoint to obtain the pipeline and stage IDs needed when creating or updating deals.

#### 🔌 Usage

```typescript await client.deals.getAPipeline({ pipelineID: "pipelineID" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmPipelineDetailsPipelineIdRequest`

**requestOptions:** `DealsClient.RequestOptions`

## Files

client.files.getAllFiles({ ...params }) -> Brevo.FileData[]

#### 📝 Description

Retrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 files per page.

#### 🔌 Usage

```typescript await client.files.getAllFiles(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmFilesRequest`

**requestOptions:** `FilesClient.RequestOptions`

client.files.uploadAFile({ ...params }) -> Brevo.FileData

#### 📝 Description

Upload a file and associate it with a contact, company, or deal. The file must be sent as multipart form data with a maximum size of 10 MB. You can optionally link the file to a specific entity by providing the corresponding entity ID.

#### 🔌 Usage

```typescript await client.files.uploadAFile({ file: fs.createReadStream("/path/to/your/file") }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCrmFilesRequest`

**requestOptions:** `FilesClient.RequestOptions`

client.files.downloadAFile({ ...params }) -> Brevo.GetCrmFilesIdResponse

#### 📝 Description

Get a temporary download URL for a CRM file by its identifier. The returned URL is valid for 5 minutes only and provides direct access to the file content.

#### 🔌 Usage

```typescript await client.files.downloadAFile({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmFilesIdRequest`

**requestOptions:** `FilesClient.RequestOptions`

client.files.deleteAFile({ ...params }) -> void

#### 📝 Description

Permanently delete a CRM file by its identifier. This removes the file from storage and unlinks it from any associated contacts, companies, or deals.

#### 🔌 Usage

```typescript await client.files.deleteAFile({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCrmFilesIdRequest`

**requestOptions:** `FilesClient.RequestOptions`

client.files.getFileDetails({ ...params }) -> Brevo.FileData

#### 📝 Description

Retrieve the metadata and details of a specific CRM file by its identifier. This returns information such as the file name, size, type, creation date, and associated entities, but does not include the file content itself.

#### 🔌 Usage

```typescript await client.files.getFileDetails({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmFilesIdDataRequest`

**requestOptions:** `FilesClient.RequestOptions`

## Notes

client.notes.getAllNotes({ ...params }) -> Brevo.Note[]

#### 📝 Description

Retrieve a paginated list of CRM notes with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 notes per page.

#### 🔌 Usage

```typescript await client.notes.getAllNotes(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmNotesRequest`

**requestOptions:** `NotesClient.RequestOptions`

client.notes.createANote({ ...params }) -> Brevo.PostCrmNotesResponse

#### 📝 Description

Create a new CRM note and optionally associate it with contacts, companies, or deals. The note text content is required, and you can link the note to multiple entities simultaneously during creation.

#### 🔌 Usage

```typescript await client.notes.createANote({ text: "

Meeting notes: Action item - visit Brevo for details.

" }); ```

#### ⚙️ Parameters

**request:** `Brevo.NoteData`

**requestOptions:** `NotesClient.RequestOptions`

client.notes.getANote({ ...params }) -> Brevo.Note

#### 📝 Description

Retrieve the full details of a single CRM note by its identifier. The response includes the note''s text content, creation date, author, and any associated contacts, companies, or deals.

#### 🔌 Usage

```typescript await client.notes.getANote({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmNotesIdRequest`

**requestOptions:** `NotesClient.RequestOptions`

client.notes.deleteANote({ ...params }) -> void

#### 📝 Description

Permanently delete a CRM note by its identifier. This removes the note and unlinks it from any associated contacts, companies, or deals.

#### 🔌 Usage

```typescript await client.notes.deleteANote({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCrmNotesIdRequest`

**requestOptions:** `NotesClient.RequestOptions`

client.notes.updateANote({ ...params }) -> void

#### 📝 Description

Update an existing CRM note''s text content and its associations with contacts, companies, or deals. You can modify the note text, change the pinned status, or update the linked entities.

#### 🔌 Usage

```typescript await client.notes.updateANote({ id: "id", body: { text: "

Meeting notes: Action item - visit Brevo for details.

" } }); ```

#### ⚙️ Parameters

**request:** `Brevo.PatchCrmNotesIdRequest`

**requestOptions:** `NotesClient.RequestOptions`

## Tasks

client.tasks.getAllTasks({ ...params }) -> Brevo.GetCrmTasksResponse

#### 📝 Description

Retrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities (contacts, deals, companies). Results are sorted by creation date in descending order by default, with a default limit of 50 tasks per page.

#### 🔌 Usage

```typescript await client.tasks.getAllTasks({ sortBy: "name" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmTasksRequest`

**requestOptions:** `TasksClient.RequestOptions`

client.tasks.createATask({ ...params }) -> Brevo.PostCrmTasksResponse

#### 📝 Description

Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals. A task requires a name, task type ID, and due date at minimum. You can also set a duration, notes, a reminder, and assign the task to a specific user.

#### 🔌 Usage

```typescript await client.tasks.createATask({ date: "2021-11-01T17:44:54Z", name: "Task: Connect with client", taskTypeId: "61a5cd07ca1347c82306ad09" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostCrmTasksRequest`

**requestOptions:** `TasksClient.RequestOptions`

client.tasks.getATask({ ...params }) -> Brevo.Task

#### 📝 Description

Retrieve the full details of a single CRM task by its identifier. The response includes the task''s name, type, status, due date, duration, notes, assignee, reminder settings, and linked contacts, companies, or deals.

#### 🔌 Usage

```typescript await client.tasks.getATask({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetCrmTasksIdRequest`

**requestOptions:** `TasksClient.RequestOptions`

client.tasks.deleteATask({ ...params }) -> void

#### 📝 Description

Permanently delete a CRM task by its identifier. This removes the task and cancels any associated reminders. The requesting user must be the task assignee or have manage permission on tasks.

#### 🔌 Usage

```typescript await client.tasks.deleteATask({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteCrmTasksIdRequest`

**requestOptions:** `TasksClient.RequestOptions`

client.tasks.updateATask({ ...params }) -> void

#### 📝 Description

Update an existing CRM task''s properties such as name, type, due date, status, duration, notes, assignee, reminder, or linked entities. Only the fields provided in the request body will be updated; omitted fields remain unchanged.

#### 🔌 Usage

```typescript await client.tasks.updateATask({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PatchCrmTasksIdRequest`

**requestOptions:** `TasksClient.RequestOptions`

client.tasks.getAllTaskTypes() -> Brevo.GetCrmTasktypesResponseItem[]

#### 📝 Description

Retrieve the list of all available task types, such as Email, Call, Meeting, Todo, Lunch, Deadline, and LinkedIn. If no task types exist yet, the default set is automatically created and returned. Use the task type ID when creating or updating tasks.

#### 🔌 Usage

```typescript await client.tasks.getAllTaskTypes(); ```

#### ⚙️ Parameters

**requestOptions:** `TasksClient.RequestOptions`

## TransactionalWhatsApp

client.transactionalWhatsApp.sendWhatsappMessage({ ...params }) -> Brevo.SendWhatsappMessageResponse

#### 📝 Description

You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below. [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account This endpoint is used to send a WhatsApp message.
(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)

#### 🔌 Usage

```typescript await client.transactionalWhatsApp.sendWhatsappMessage({ contactNumbers: ["contactNumbers"], senderNumber: "senderNumber", templateId: 123 }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendWhatsappMessageRequest`

**requestOptions:** `TransactionalWhatsAppClient.RequestOptions`

client.transactionalWhatsApp.getWhatsappEventReport({ ...params }) -> Brevo.GetWhatsappEventReportResponse

#### 📝 Description

This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days)

#### 🔌 Usage

```typescript await client.transactionalWhatsApp.getWhatsappEventReport(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetWhatsappEventReportRequest`

**requestOptions:** `TransactionalWhatsAppClient.RequestOptions`

## TransactionalEmails

client.transactionalEmails.getTransacBlockedContacts({ ...params }) -> Brevo.GetTransacBlockedContactsResponse

#### 📝 Description

Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both `startDate` and `endDate` must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the `sort` parameter.

#### 🔌 Usage

```typescript await client.transactionalEmails.getTransacBlockedContacts(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetTransacBlockedContactsRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.unblockOrResubscribeATransactionalContact({ ...params }) -> void

#### 📝 Description

Unblock or resubscribe a transactional contact by removing their email address from the blacklist. The email address must be URL-encoded in the path parameter and must be a valid email format. If the contact is not found in the blocklist, a 404 error is returned.

#### 🔌 Usage

```typescript await client.transactionalEmails.unblockOrResubscribeATransactionalContact({ email: "email" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteSmtpBlockedContactsEmailRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getBlockedDomains() -> Brevo.GetBlockedDomainsResponse

#### 📝 Description

Get the list of blocked domains

#### 🔌 Usage

```typescript await client.transactionalEmails.getBlockedDomains(); ```

#### ⚙️ Parameters

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.blockNewDomain({ ...params }) -> void

#### 📝 Description

Blocks a new domain in order to avoid messages being sent to the same

#### 🔌 Usage

```typescript await client.transactionalEmails.blockNewDomain({ domain: "example.com" }); ```

#### ⚙️ Parameters

**request:** `Brevo.BlockNewDomainRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.deleteBlockedDomain({ ...params }) -> void

#### 📝 Description

Unblocks an existing domain from the list of blocked domains

#### 🔌 Usage

```typescript await client.transactionalEmails.deleteBlockedDomain({ domain: "domain" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteBlockedDomainRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.deleteHardbounces({ ...params }) -> void

#### 📝 Description

Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)

#### 🔌 Usage

```typescript await client.transactionalEmails.deleteHardbounces(); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteHardbouncesRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.sendTransacEmail({ ...params }) -> Brevo.SendTransacEmailResponse

#### 📝 Description

Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`. You can schedule emails for future delivery using `scheduledAt` (UTC, up to 5-minute delay), send multiple personalized versions with `messageVersions` (max 2000 total recipients, 99 per version), and attach files via URL or base64-encoded content. A `sender` and `subject` are required when no `templateId` is provided; when a `templateId` is used, the template''s sender and subject are applied unless overridden.

#### 🔌 Usage

```typescript await client.transactionalEmails.sendTransacEmail({ htmlContent: "

Hello,

This is my first transactional email sent from Brevo.

", sender: { email: "hello@brevo.com", name: "Alex from Brevo" }, subject: "Hello from Brevo!", to: [{ email: "johndoe@example.com", name: "John Doe" }] }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendTransacEmailRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.deleteScheduledEmailById({ ...params }) -> void

#### 📝 Description

Delete scheduled batch of emails by batchId or single scheduled email by messageId

#### 🔌 Usage

```typescript await client.transactionalEmails.deleteScheduledEmailById({ identifier: "4320f270-a4e3-4a2e-b591-edfe30a5e627" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteScheduledEmailByIdRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getScheduledEmailById({ ...params }) -> Brevo.GetScheduledEmailByIdResponse

#### 📝 Description

Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old)

#### 🔌 Usage

```typescript await client.transactionalEmails.getScheduledEmailById({ identifier: "4320f270-a4e3-4a2e-b591-edfe30a5e627", startDate: "2022-02-02", endDate: "2022-03-02" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetScheduledEmailByIdRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getTransacEmailsList({ ...params }) -> Brevo.GetTransacEmailsListResponse

#### 📝 Description

This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.

#### 🔌 Usage

```typescript await client.transactionalEmails.getTransacEmailsList(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetTransacEmailsListRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getTransacEmailContent({ ...params }) -> Brevo.GetTransacEmailContentResponse

#### 📝 Description

You can get the uuid using either of the following methods: Send a GET request to https://api.brevo.com/v3/smtp/emails and pass the message_id in the url. Use your api-key to authenticate the request and you will get your uuid as a response. The uuid can also be fetched from the transactional logs page in your Brevo account, from the address URL.

#### 🔌 Usage

```typescript await client.transactionalEmails.getTransacEmailContent({ uuid: "uuid" }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetTransacEmailContentRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.deleteAnSmtpTransactionalLog({ ...params }) -> void

#### 📝 Description

Delete SMTP transactional log entries identified by a message ID (enclosed in angle brackets with an @ sign) or a valid email address. Optionally narrow the deletion to a specific date range using `from_date` and `to_date` query parameters (YYYY-MM-DD format). The operation also removes any associated stored email preview content.

#### 🔌 Usage

```typescript await client.transactionalEmails.deleteAnSmtpTransactionalLog({ identifier: "identifier" }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteSmtpLogIdentifierRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getAggregatedSmtpReport({ ...params }) -> Brevo.GetAggregatedSmtpReportResponse

#### 📝 Description

This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days

#### 🔌 Usage

```typescript await client.transactionalEmails.getAggregatedSmtpReport(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetAggregatedSmtpReportRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getEmailEventReport({ ...params }) -> Brevo.GetEmailEventReportResponse

#### 📝 Description

This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days

#### 🔌 Usage

```typescript await client.transactionalEmails.getEmailEventReport(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetEmailEventReportRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getSmtpReport({ ...params }) -> Brevo.GetSmtpReportResponse

#### 📝 Description

This endpoint will show the aggregated stats per day for the past 10 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 30 days.

#### 🔌 Usage

```typescript await client.transactionalEmails.getSmtpReport(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSmtpReportRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.postPreviewSmtpEmailTemplates({ ...params }) -> Brevo.PostPreviewSmtpEmailTemplatesResponse

#### 📝 Description

Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an `email` address (to populate variables from the contact''s attributes) or a `params` object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory `templateId`. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.

#### 🔌 Usage

```typescript await client.transactionalEmails.postPreviewSmtpEmailTemplates({ "key": "value" }); ```

#### ⚙️ Parameters

**request:** `Brevo.PostPreviewSmtpEmailTemplatesRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getSmtpTemplates({ ...params }) -> Brevo.GetSmtpTemplatesResponse

#### 📝 Description

Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden. You can filter by active/inactive status using `templateStatus` and by editor type using `editorType` (currently only `richTextEditor` is supported).

#### 🔌 Usage

```typescript await client.transactionalEmails.getSmtpTemplates(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSmtpTemplatesRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.createSmtpTemplate({ ...params }) -> Brevo.CreateSmtpTemplateResponse

#### 📝 Description

Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied. Templates are created as inactive by default unless `isActive` is explicitly set to `true`.

#### 🔌 Usage

```typescript await client.transactionalEmails.createSmtpTemplate({ sender: {}, subject: "Thanks for your purchase !", templateName: "Order Confirmation - EN" }); ```

#### ⚙️ Parameters

**request:** `Brevo.CreateSmtpTemplateRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.getSmtpTemplate({ ...params }) -> Brevo.GetSmtpTemplateOverview

#### 📝 Description

Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a `doiTemplate` flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).

#### 🔌 Usage

```typescript await client.transactionalEmails.getSmtpTemplate({ templateId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSmtpTemplateRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.updateSmtpTemplate({ ...params }) -> void

#### 📝 Description

Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated. You can update the template name, subject, sender, reply-to address, HTML content (via `htmlContent` or `htmlUrl`), active status, tag, attachment URL, and the personalized `toField`. Only one of sender email or sender ID should be provided per request.

#### 🔌 Usage

```typescript await client.transactionalEmails.updateSmtpTemplate({ templateId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.UpdateSmtpTemplateRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.deleteSmtpTemplate({ ...params }) -> void

#### 📝 Description

Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`. Deletion also removes associated newsletter template data and triggers asynchronous cleanup of shared assets.

#### 🔌 Usage

```typescript await client.transactionalEmails.deleteSmtpTemplate({ templateId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Brevo.DeleteSmtpTemplateRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

client.transactionalEmails.sendTestTemplate({ ...params }) -> void

#### 📝 Description

Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your entire test list. You can send a maximum of 50 test emails per day, and all provided email addresses must be valid.

#### 🔌 Usage

```typescript await client.transactionalEmails.sendTestTemplate({ templateId: 1000000, body: {} }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendTestTemplateRequest`

**requestOptions:** `TransactionalEmailsClient.RequestOptions`

## TransactionalSms

client.transactionalSms.sendAsyncTransactionalSms({ ...params }) -> Brevo.SendAsyncTransactionalSmsResponse

#### 📝 Description

If the user includes stop code in the Transactional SMS, then it will be switched to Marketing SMS automatically and it will be interpreted as a Marketing SMS. To send Transactional SMS as Transactional, it is important not to use stop code. Note: For adding a stop code, client has to add reply STOP to [STOP_CODE] and the [STOP_CODE] will be replaced with the number. Transactional SMS can be sent at any time without time restrictions. However, if a message is categorized as Marketing, it must adhere to specific time restrictions. Messages sent outside of these restricted hours will experience delays and will be processed during allowable times. Specifically, Marketing SMS cannot be processed between 10pm and 8am, on Sundays, and on French public holidays.

#### 🔌 Usage

```typescript await client.transactionalSms.sendAsyncTransactionalSms({ recipient: "33689965433", sender: "MyShop" }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendTransacSms`

**requestOptions:** `TransactionalSmsClient.RequestOptions`

client.transactionalSms.sendTransacSms({ ...params }) -> Brevo.SendTransacSmsResponse

#### 📝 Description

Send a transactional SMS message to a single mobile number. The `sender`, `recipient`, and either `content` or `templateId` fields are required. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the recipient must be a valid international phone number (6-15 digits, optional leading +). Tags can be a string or an array of up to 10 strings. The SMS type defaults to `transactional` but can be set to `marketing`; if the content includes a stop code, it is automatically treated as marketing. Returns the message ID, SMS count, credits used, and remaining credits.

#### 🔌 Usage

```typescript await client.transactionalSms.sendTransacSms({ recipient: "33689965433", sender: "MyShop" }); ```

#### ⚙️ Parameters

**request:** `Brevo.SendTransacSms`

**requestOptions:** `TransactionalSmsClient.RequestOptions`

client.transactionalSms.getTransacAggregatedSmsReport({ ...params }) -> Brevo.GetTransacAggregatedSmsReportResponse

#### 📝 Description

Retrieve an aggregated report of your transactional SMS activity over a specified time period, including counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format) or by a number of past `days` (not compatible with date range). You can further narrow results by `tag`. If no date filter is provided, the report covers all available data and returns the auto-detected date range.

#### 🔌 Usage

```typescript await client.transactionalSms.getTransacAggregatedSmsReport(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetTransacAggregatedSmsReportRequest`

**requestOptions:** `TransactionalSmsClient.RequestOptions`

client.transactionalSms.getSmsEvents({ ...params }) -> Brevo.GetSmsEventsResponse

#### 📝 Description

Retrieve a paginated list of individual SMS event records (unaggregated), including event type, phone number, message ID, timestamp, tag, and reason or reply content where applicable. Results default to 50 per page (max 100) and are sorted in descending order unless overridden. Filter by date range (`startDate`/`endDate`), past `days` (not compatible with date range), specific `event` type (e.g. delivered, bounces, replies), `phoneNumber`, or `tags`. Bounce events include the failure reason, and reply events include the reply content.

#### 🔌 Usage

```typescript await client.transactionalSms.getSmsEvents(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSmsEventsRequest`

**requestOptions:** `TransactionalSmsClient.RequestOptions`

client.transactionalSms.getTransacSmsReport({ ...params }) -> Brevo.GetTransacSmsReportResponse

#### 📝 Description

Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format), by a number of past `days` (not compatible with date range), or by `tag`. Results are sorted in descending order by default unless overridden with the `sort` parameter.

#### 🔌 Usage

```typescript await client.transactionalSms.getTransacSmsReport(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetTransacSmsReportRequest`

**requestOptions:** `TransactionalSmsClient.RequestOptions`

## SmsTemplates

client.smsTemplates.getSmsTemplates({ ...params }) -> Brevo.GetSmsTemplatesResponse

#### 🔌 Usage

```typescript await client.smsTemplates.getSmsTemplates(); ```

#### ⚙️ Parameters

**request:** `Brevo.GetSmsTemplatesRequest`

**requestOptions:** `SmsTemplatesClient.RequestOptions`