# WhatsAppCampaign_RecipientsExcludedLists Get a WhatsApp campaign 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) - 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) |