@getbrevo/brevo 5.0.0 → 5.0.3

package/reference.md

@@ -3638,22 +3638,16 @@ await client.webhooks.createWebhook({
 <dl>
 <dd>
 
-<Note title="This feature is available for Professional and Enterprise plans">
-To have it activated please send us a request and we will activate it for your account.
+<Note>
+This is an enterprise feature. Contact us to activate it for your account.
 </Note>
 
-Exports webhook event history to CSV format for analysis and reporting.
-
-Use this to:
-- Generate comprehensive webhook event reports
-- Analyze webhook delivery patterns and success rates
-- Export event data for external analysis tools
-- Create historical reports for compliance and auditing
-- Track webhook performance and reliability metrics
+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.
 
-Key information returned:
-- Process ID for tracking export completion
-- CSV file will be delivered to specified webhook URL
+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
 </dd>
 </dl>
 </dd>
@@ -4381,12 +4375,8 @@ await client.externalFeeds.deleteExternalFeed({
 <dl>
 <dd>
 
-<Note title="Enterprise access only">
-Custom objects are only available to Enterprise plans.
-
-This feature is in beta. These are subject to change.
-</Note>
-
+<Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
+This feature is in beta. These are subject to change.</Note>
 This API allows bulk upsert of object records in a single request. Each object record may include
   - Attributes
   - Identifiers
@@ -4400,8 +4390,8 @@ This API allows bulk upsert of object records in a single request. Each object r
   - Max 500 attributes defined per object record upsert request
     - This is coherent with schema limitation: an object cannot have more than 500 attributes.
     - Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
-  - Max 10 associations defined per object record upsert request
-    - This is coherent with schema limitation: an object cannot have more than 10 associations with other objects. and each object record can be linked to max 10 other records.
+  - Max 10 associations defined per associated object type, in each record of the request
+    - This is not a schema limitation. You can associate an object record to an unlimited number of other object records by running multiple requests.
 **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".
@@ -4470,12 +4460,8 @@ await client.customObjects.upsertrecords({
 <dl>
 <dd>
 
-<Note title="Enterprise access only">
-Custom objects are only available to Enterprise plans.
-
-This feature is in beta. These are subject to change.
-</Note>
-
+<Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
+This feature is in beta. These are subject to change.</Note>
 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.
 </dd>
 </dl>
@@ -4606,26 +4592,6 @@ await client.customObjects.batchDeleteObjectRecords({
 <dl>
 <dd>
 
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-<Note title="Follow this format when passing a SMS phone number as an attribute">
-Accepted Number Formats
-
-91xxxxxxxxxx
-+91xxxxxxxxxx
-0091xxxxxxxxxx
-</Note>
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -4683,6 +4649,8 @@ await client.contacts.getContacts();
 <dl>
 <dd>
 
+<Note>Follow this format when passing a "SMS" phone number as an attribute.
+Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
 Creates new contacts on Brevo. Contacts can be created by passing either - <br><br> 1. email address of the contact (email_id),  <br> 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"} <br> 3. ext_id <br>
 </dd>
 </dl>
@@ -5045,9 +5013,7 @@ await client.contacts.updateBatchContacts();
 <dl>
 <dd>
 
-<Note title="How to use attributes param?">
-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.
-</Note>
+<Note title="How to use attributes param?">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.</Note>
 </dd>
 </dl>
 </dd>
@@ -5180,17 +5146,11 @@ await client.contacts.requestContactExport({
 <dl>
 <dd>
 
-<Note>
-Ongoing changes for this endpoint
-
+<Note>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
-</Note>
+The uniqueSubscribers field is deprecated</Note>
 </dd>
 </dl>
 </dd>
@@ -5302,13 +5262,9 @@ await client.contacts.createFolder({});
 <dl>
 <dd>
 
-<Note>
-Ongoing changes for this endpoint.
-
+<Note>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.
-</Note>
+These are non breaking changes. The default value for the attributes will be 0.</Note>
 </dd>
 </dl>
 </dd>
@@ -5476,13 +5432,9 @@ await client.contacts.deleteFolder({
 <dl>
 <dd>
 
-<Note>
-Ongoing changes for this endpoint.
-
+<Note>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.
-</Note>
+These are non breaking changes. The default value for the attributes will be 0.</Note>
 </dd>
 </dl>
 </dd>
@@ -5610,13 +5562,9 @@ await client.contacts.importContacts();
 <dl>
 <dd>
 
-<Note>
-Ongoing changes for this endpoint.
-
+<Note>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.
-</Note>
+These are non breaking changes. The default value for the attributes will be 0.</Note>
 </dd>
 </dl>
 </dd>
@@ -6092,14 +6040,8 @@ await client.contacts.getSegments();
 <dl>
 <dd>
 
-<Note title="Follow this format when passing a SMS phone number as an attribute">
-Accepted Number Formats
-
-91xxxxxxxxxx
-+91xxxxxxxxxx
-0091xxxxxxxxxx
-</Note>
-
+<Note>Follow this format when passing a "SMS" phone number as an attribute.
+Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
 There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> 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.   <br><br> 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 <br><br>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.
 </dd>
 </dl>
@@ -6165,6 +6107,8 @@ await client.contacts.getContactInfo({
 <dl>
 <dd>
 
+<Note>Follow this format when passing a "SMS" phone number as an attribute.
+Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx <br><br> If a blocklisted contact's email address is updated, it is going to remove that blocklisting from the contact and they will be resubscribed.</Note>
 There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> 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.   <br><br> 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
 </dd>
 </dl>
@@ -7525,8 +7469,7 @@ await client.ecommerce.createOrder({
     id: "14",
     products: [{
             price: 99.99,
-            productId: "P1",
-            quantity: 10
+            productId: "P1"
         }],
     status: "completed",
     updatedAt: "2021-07-30T10:59:23.383Z"
@@ -7600,8 +7543,7 @@ await client.ecommerce.createBatchOrder({
             id: "14",
             products: [{
                     price: 99.99,
-                    productId: "P1",
-                    quantity: 10
+                    productId: "P1"
                 }],
             status: "completed",
             updatedAt: "2021-07-30T10:59:23.383Z"
@@ -8316,6 +8258,73 @@ await client.payments.deletePaymentRequest({
 </details>
 
 ## Event
+<details><summary><code>client.event.<a href="/src/api/resources/event/client/Client.ts">getEvents</a>({ ...params }) -> Brevo.GetEventsList</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+<Note>
+This endpoint currently only supports custom events.
+</Note>
+
+Retrieve a list of events filtered by various criteria.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.event.getEvents();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Brevo.GetEventsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EventClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.event.<a href="/src/api/resources/event/client/Client.ts">createEvent</a>({ ...params }) -> void</code></summary>
 <dl>
 <dd>
@@ -8378,6 +8387,72 @@ await client.event.createEvent({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.event.<a href="/src/api/resources/event/client/Client.ts">createBatchEvents</a>({ ...params }) -> Brevo.BatchAcceptedResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create multiple events to track contacts' interactions in a single request.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.event.createBatchEvents([{
+        event_name: "order_created",
+        identifiers: {}
+    }]);
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Brevo.CreateBatchEventsRequestItem[]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EventClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -9550,8 +9625,8 @@ Returns transaction history
 ```typescript
 await client.balance.getTransactionHistoryApi({
     pid: "pid",
-    contact_id: 1,
-    balance_definition_id: "balance_definition_id"
+    contactId: 1,
+    balanceDefinitionId: "balanceDefinitionId"
 });
 
 ```
@@ -10238,6 +10313,72 @@ await client.program.getParameterSubscriptionInfo({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.program.<a href="/src/api/resources/program/client/Client.ts">deleteContactSubscription</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete subscription for a contact
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.program.deleteContactSubscription({
+    pid: "pid",
+    cid: 1
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Brevo.DeleteContactSubscriptionRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProgramClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -11844,11 +11985,8 @@ await client.tier.deleteTier({
 <dl>
 <dd>
 
-<Note>
-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/get-all-marketing-campaigns).
-</Note>
+<Note>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/get-all-marketing-campaigns).</Note>
 </dd>
 </dl>
 </dd>
@@ -13172,19 +13310,11 @@ await client.whatsAppCampaigns.getWhatsAppCampaigns();
 <dl>
 <dd>
 
-<Note>
-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
-</Note>
-
-<Note>
-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.
-
+<Note>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</Note>
+<Note>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)
-</Note>
+[Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
 </dd>
 </dl>
 </dd>
@@ -13252,11 +13382,8 @@ await client.whatsAppCampaigns.createWhatsAppCampaign({
 <dl>
 <dd>
 
-<Note>
-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
-</Note>
+<Note>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</Note>
 </dd>
 </dl>
 </dd>
@@ -13311,11 +13438,8 @@ await client.whatsAppCampaigns.getWhatsAppConfig();
 <dl>
 <dd>
 
-<Note>
-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
-</Note>
+<Note>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</Note>
 </dd>
 </dl>
 </dd>
@@ -13432,11 +13556,8 @@ await client.whatsAppCampaigns.getWhatsAppTemplates();
 <dl>
 <dd>
 
-<Note>
-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
-</Note>
+<Note>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</Note>
 </dd>
 </dl>
 </dd>
@@ -13501,11 +13622,11 @@ await client.whatsAppCampaigns.sendWhatsAppTemplateApproval({
 <dl>
 <dd>
 
-<Note>
-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
-</Note>
+<Note>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</Note>
+<Note>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)</Note>
 </dd>
 </dl>
 </dd>
@@ -13570,19 +13691,11 @@ await client.whatsAppCampaigns.getWhatsAppCampaign({
 <dl>
 <dd>
 
-<Note>
-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
-</Note>
-
-<Note>
-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.
-
+<Note>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</Note>
+<Note>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)
-</Note>
+[Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
 </dd>
 </dl>
 </dd>
@@ -14103,6 +14216,108 @@ await client.companies.createACompanyDealAttribute({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteAnAttribute</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.companies.deleteAnAttribute({
+    id: "id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Brevo.DeleteCrmAttributesIdRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CompaniesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">updateAnAttribute</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.companies.updateAnAttribute({
+    id: "id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Brevo.PatchCrmAttributesIdRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CompaniesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -15527,7 +15742,8 @@ await client.tasks.getAllTaskTypes();
 <dl>
 <dd>
 
-<Note>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</Note>
+<Note>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</Note>
 This endpoint is used to send a WhatsApp message. <br/>(**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.**)
 </dd>
 </dl>
@@ -16262,13 +16478,9 @@ await client.transactionalEmails.getTransacEmailsList();
 <dl>
 <dd>
 
-<Note title="How to get uuid?">
-You can get the uuid using either of the following methods:
-
+<Note title="How to get uuid">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.
-</Note>
+The uuid can also be fetched from the transactional logs page in your Brevo account, from the address URL.</Note>
 </dd>
 </dl>
 </dd>
@@ -16918,15 +17130,9 @@ await client.transactionalEmails.sendTestTemplate({
 <dl>
 <dd>
 
-<Note>
-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.
-</Note>
-
-<Note title="For end users in France">
-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.
-</Note>
+<Note>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.</Note>
+<Note title="For end users in France">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.</Note>
 </dd>
 </dl>
 </dd>
@@ -17228,3 +17434,4 @@ await client.smsTemplates.getSmsTemplates();
 </dd>
 </dl>
 </details>
+