Sendinblue API Data Model
SmsCampaigns: Sendinblue SMS Campaigns |
Returns the information for all your created SMS campaignsRetrieve 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.
Catalog: Brevo
Schema: SMSCampaigns
Primary Keys: id
Label: SMS Campaigns
Can retrieve data and change data using insert, update and delete.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function SmsCampaigns. 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 |
|---|---|---|---|---|
endDate |
|
☐ |
|
**Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `endDate` must not be in the future. |
startDate |
|
☐ |
|
**Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `startDate` must not be in the future. |
status |
|
☐ |
|
Status of campaign. (Values: suspended, archive, sent, queued, draft, inProcess) |
Columns of Table Function
The columns of the table function SmsCampaigns are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
content |
varchar2 |
Content |
☐ |
Content of the SMS Campaign |
createdAt |
varchar2 |
Creation Date |
☐ |
Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
id |
int64 |
ID |
☐ |
ID of the SMS Campaign |
modifiedAt |
varchar2 |
Modified Date |
☐ |
UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
name |
varchar2 |
Name |
☐ |
Name of the SMS Campaign |
organisationPrefix |
varchar2 |
|
☐ |
A recognizable prefix added as the Brand Name before the message content. Empty string if not set. |
recipients |
varchar2 |
Recipients |
☐ |
|
scheduledAt |
varchar2 |
Schedule Date |
☐ |
UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled. |
sender |
varchar2 |
Sender |
☐ |
Sender of the SMS Campaign |
sentDate |
varchar2 |
Sent Date |
☐ |
UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is 'sent'. |
statistics |
varchar2 |
Statistics |
☐ |
|
status |
varchar2 |
Status |
☐ |
Status of the SMS Campaign |
unsubscribeInstruction |
varchar2 |
|
☐ |
Instructions to unsubscribe from future communications. Empty string if not set. |
