Skip to content

Latest commit

 

History

History
127 lines (93 loc) · 3.97 KB

WhatsappCampaignsApi.md

File metadata and controls

127 lines (93 loc) · 3.97 KB

WhatsappCampaignsApi

All URIs are relative to https://api.sendinblue.com/v3

Method HTTP request Description
deleteWhatsappCampaign DELETE /whatsappCampaigns/{campaignId} Delete a whatsapp campaign
getWhatsappCampaign GET /whatsappCampaigns/{campaignId} Get Whatsapp campaign Overview

deleteWhatsappCampaign

deleteWhatsappCampaign(campaignId)

Delete a whatsapp campaign

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.WhatsappCampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

WhatsappCampaignsApi apiInstance = new WhatsappCampaignsApi();
Object campaignId = null; // Object | id of the campaign
try {
    apiInstance.deleteWhatsappCampaign(campaignId);
} catch (ApiException e) {
    System.err.println("Exception when calling WhatsappCampaignsApi#deleteWhatsappCampaign");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
campaignId Object id of the campaign

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getWhatsappCampaign

GetWhatsappCampaignOverview getWhatsappCampaign(campaignId)

Get Whatsapp campaign Overview

Example

// Import classes:
//import sendinblue.ApiClient;
//import sendinblue.ApiException;
//import sendinblue.Configuration;
//import sendinblue.auth.*;
//import sibApi.WhatsappCampaignsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

WhatsappCampaignsApi apiInstance = new WhatsappCampaignsApi();
Object campaignId = null; // Object | Id of the campaign
try {
    GetWhatsappCampaignOverview result = apiInstance.getWhatsappCampaign(campaignId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WhatsappCampaignsApi#getWhatsappCampaign");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
campaignId Object Id of the campaign

Return type

GetWhatsappCampaignOverview

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json