All URIs are relative to https://api.brevo.com/v3
Method | HTTP request | Description |
---|---|---|
CreateWhatsAppCampaign | Post /whatsappCampaigns | Create and Send a WhatsApp campaign |
CreateWhatsAppTemplate | Post /whatsppCampaigns/template | Create a WhatsApp template |
DeleteWhatsAppCampaign | Delete /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign |
GetWhatsAppCampaign | Get /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign |
GetWhatsAppCampaigns | Get /whatsappCampaigns | Return all your created WhatsApp campaigns |
GetWhatsAppConfig | Get /whatsappCampaigns/config | Get your WhatsApp API account information |
GetWhatsAppTemplates | Get /whatsappCampaigns/template-list | Return all your created WhatsApp templates |
SendWhatsAppTemplateApproval | Post /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval |
UpdateWhatsAppCampaign | Put /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign |
CreateModel CreateWhatsAppCampaign(ctx, whatsAppCampaigns) Create and Send a WhatsApp campaign
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
whatsAppCampaigns | CreateWhatsAppCampaign | Values to create a campaign |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateModel CreateWhatsAppTemplate(ctx, whatsAppTemplates) Create a WhatsApp template
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
whatsAppTemplates | CreateWhatsAppTemplate | Values to create a template |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteWhatsAppCampaign(ctx, campaignId) Delete a WhatsApp campaign
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]
GetWhatsappCampaignOverview GetWhatsAppCampaign(ctx, campaignId) Get a WhatsApp campaign
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
campaignId | int64 | Id of the campaign |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetWhatsappCampaigns GetWhatsAppCampaigns(ctx, optional) Return all your created WhatsApp campaigns
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *GetWhatsAppCampaignsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetWhatsAppCampaignsOpts struct
Name | Type | Description | Notes |
---|---|---|---|
startDate | optional.String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. Prefer to pass your timezone in date-time format for accurate result | |
endDate | optional.String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. Prefer to pass your timezone in date-time format for accurate result | |
limit | optional.Int64 | Number of documents per page | [default to 50] |
offset | optional.Int64 | Index of the first document in the page | [default to 0] |
sort | optional.String | Sort the results in the ascending/descending order of record modification. 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]
GetWhatsAppConfig GetWhatsAppConfig(ctx, ) Get your WhatsApp API account information
This endpoint does not need any parameter.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetWaTemplates GetWhatsAppTemplates(ctx, optional) Return all your created WhatsApp templates
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *GetWhatsAppTemplatesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetWhatsAppTemplatesOpts struct
Name | Type | Description | Notes |
---|---|---|---|
startDate | optional.String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result | |
endDate | optional.String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result | |
limit | optional.Int64 | Number of documents per page | [default to 50] |
offset | optional.Int64 | Index of the first document in the page | [default to 0] |
sort | optional.String | Sort the results in the ascending/descending order of record modification. Default order is descending if `sort` is not passed | [default to desc] |
source | optional.String | source of the template |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SendWhatsAppTemplateApproval(ctx, templateId) Send your WhatsApp template for approval
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
templateId | 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]
UpdateWhatsAppCampaign(ctx, campaignId, optional) Update a WhatsApp campaign
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
campaignId | int64 | Id of the campaign | |
optional | *UpdateWhatsAppCampaignOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UpdateWhatsAppCampaignOpts struct
Name | Type | Description | Notes |
---|
whatsAppCampaign | optional.Interface of UpdateWhatsAppCampaign| values to update WhatsApp 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]