Please enable JavaScript to view this site.

Made in EU
Sendinblue Forums

Sendinblue API Data Model

Navigation: Catalog: Brevo > Schemas > Schema: WhatsAppCampaigns > Tables

WhatsAppCampaign_RecipientsExcludedLists

Get a WhatsApp campaignYou 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 accountThis 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)

Catalog: Brevo

Schema: WhatsAppCampaigns

This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function WhatsAppCampaign_RecipientsExcludedLists. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

campaignId

 

☑

 

Id of the campaign

 

Columns of Table Function

The columns of the table function WhatsAppCampaign_RecipientsExcludedLists are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

campaignName

varchar2

 

☐

Name of the WhatsApp Campaign

campaignStatus

varchar2

 

☐

Status of the WhatsApp Campaign

createdAt

varchar2

Creation Date

☐

Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

id

int64

ID

☐

ID of the WhatsApp Campaign

includedLists

varchar2

 

☐

List of included list IDs

modifiedAt

varchar2

Modified Date

☐

UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

scheduledAt

varchar2

Schedule Date

☐

UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format

segments

varchar2

 

☐

List of segment IDs

senderNumber

varchar2

 

☐

Sender of the WhatsApp Campaign

stats_delivered

int64

#Delivered

☐

 

stats_notSent

int64

 

☐

 

stats_read

int64

 

☐

 

stats_sent

int64

#Sent

☐

 

stats_unsubscribe

int64

 

☐

 

template_button_type

varchar2

 

☐

 

template_category

varchar2

 

☐

description of the template

template_contains_button

char

 

☐

 

template_display_header

char

 

☐

 

template_header_type

varchar2

 

☐

type of header

template_hide_footer

char

 

☐

 

template_language

varchar2

 

☐

language of the template

template_name

varchar2

 

☐

name of the template

TEXT

int64

Text

☐

 

type

varchar2

Type

☐

Type of recipients (list or segment)

 

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer