All URIs are relative to https://api.sendinblue.com/v3
| Method | HTTP request | Description |
|---|---|---|
| CreateSmsCampaign | Post /smsCampaigns | Creates an SMS campaign |
| DeleteSmsCampaign | Delete /smsCampaigns/{campaignId} | Delete an SMS campaign |
| GetSmsCampaign | Get /smsCampaigns/{campaignId} | Get an SMS campaign |
| GetSmsCampaigns | Get /smsCampaigns | Returns the information for all your created SMS campaigns |
| RequestSmsRecipientExport | Post /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients |
| SendSmsCampaignNow | Post /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately |
| SendSmsReport | Post /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report |
| SendTestSms | Post /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign |
| UpdateSmsCampaign | Put /smsCampaigns/{campaignId} | Update an SMS campaign |
| UpdateSmsCampaignStatus | Put /smsCampaigns/{campaignId}/status | Update a campaign's status |
CreateModel CreateSmsCampaign(ctx, createSmsCampaign) Creates an SMS campaign
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createSmsCampaign | CreateSmsCampaign | Values to create an SMS Campaign |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteSmsCampaign(ctx, campaignId) Delete an SMS campaign
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | id of the SMS campaign |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSmsCampaign GetSmsCampaign(ctx, campaignId) Get an SMS campaign
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | id of the SMS campaign |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSmsCampaigns GetSmsCampaigns(ctx, optional) Returns the information for all your created SMS campaigns
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetSmsCampaignsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetSmsCampaignsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| status | optional.String | Status of campaign. | |
| startDate | optional.String | 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 either 'status' not passed and if passed is set to 'sent' ) | |
| endDate | optional.String | 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 either 'status' not passed and if passed is set to 'sent' ) | |
| limit | optional.Int64 | Number limitation for the result returned | [default to 500] |
| offset | optional.Int64 | Beginning point in the list to retrieve from. | [default to 0] |
| sort | optional.String | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [default to desc] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreatedProcessId RequestSmsRecipientExport(ctx, campaignId, optional) Export an SMS campaign's recipients
It returns the background process ID which on completion calls the notify URL that you have set in the input.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | id of the campaign | |
| optional | *RequestSmsRecipientExportOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RequestSmsRecipientExportOpts struct
| Name | Type | Description | Notes |
|---|
recipientExport | optional.Interface of RequestSmsRecipientExport| Values to send for a recipient export request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SendSmsCampaignNow(ctx, campaignId) Send your SMS campaign immediately
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | id of the campaign |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SendSmsReport(ctx, campaignId, sendReport) Send an SMS campaign's report
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | id of the campaign | |
| sendReport | SendReport | Values for send a report |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SendTestSms(ctx, campaignId, phoneNumber) Send a test SMS campaign
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | Id of the SMS campaign | |
| phoneNumber | SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateSmsCampaign(ctx, campaignId, updateSmsCampaign) Update an SMS campaign
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | id of the SMS campaign | |
| updateSmsCampaign | UpdateSmsCampaign | Values to update an SMS Campaign |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateSmsCampaignStatus(ctx, campaignId, status) Update a campaign's status
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| campaignId | int64 | id of the campaign | |
| status | UpdateCampaignStatus | Status of the campaign. |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]