You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*SibApiV3Sdk.EmailCampaignsApi* | [**emailExportRecipients**](docs/EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
145
145
*SibApiV3Sdk.EmailCampaignsApi* | [**getEmailCampaign**](docs/EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
146
146
*SibApiV3Sdk.EmailCampaignsApi* | [**getEmailCampaigns**](docs/EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created campaigns
147
147
*SibApiV3Sdk.EmailCampaignsApi* | [**sendEmailCampaignNow**](docs/EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
148
148
*SibApiV3Sdk.EmailCampaignsApi* | [**sendReport**](docs/EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
149
149
*SibApiV3Sdk.EmailCampaignsApi* | [**sendTestEmail**](docs/EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
150
150
*SibApiV3Sdk.EmailCampaignsApi* | [**updateCampaignStatus**](docs/EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
151
-
*SibApiV3Sdk.EmailCampaignsApi* | [**updateEmailCampaigns**](docs/EmailCampaignsApi.md#updateEmailCampaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
151
+
*SibApiV3Sdk.EmailCampaignsApi* | [**updateEmailCampaign**](docs/EmailCampaignsApi.md#updateEmailCampaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
152
152
*SibApiV3Sdk.FoldersApi* | [**createFolder**](docs/FoldersApi.md#createFolder) | **POST** /contacts/folders | Create a folder
153
153
*SibApiV3Sdk.FoldersApi* | [**deleteFolder**](docs/FoldersApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
*SibApiV3Sdk.ResellerApi* | [**getResellerChilds**](docs/ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Gets the list of all reseller's children accounts
176
176
*SibApiV3Sdk.ResellerApi* | [**removeCredits**](docs/ResellerApi.md#removeCredits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
177
177
*SibApiV3Sdk.ResellerApi* | [**updateResellerChild**](docs/ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
*SibApiV3Sdk.SMSCampaignsApi* | [**getSMSCampaigns**](docs/SMSCampaignsApi.md#getSMSCampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
*SibApiV3Sdk.SMSCampaignsApi* | [**getSmsCampaign**](docs/SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
182
-
*SibApiV3Sdk.SMSCampaignsApi* | [**requestSMSRecipientExport**](docs/SMSCampaignsApi.md#requestSMSRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
*SibApiV3Sdk.SMSCampaignsApi* | [**getSmsCampaigns**](docs/SMSCampaignsApi.md#getSmsCampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
182
+
*SibApiV3Sdk.SMSCampaignsApi* | [**requestSmsRecipientExport**](docs/SMSCampaignsApi.md#requestSmsRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
Copy file name to clipboardExpand all lines: docs/ContactsApi.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -587,7 +587,7 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
587
587
var opts = {
588
588
'limit':50, // Number | Number of documents per page
589
589
'offset':0, // Number | Index of the first document of the page
590
-
'modifiedSince':newDate("2013-10-20T19:20:30+01:00") // Date | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
590
+
'modifiedSince':newDate("2013-10-20T19:20:30+01:00") // Date | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
**limit** | **Number**| Number of documents per page | [optional][default to 50]
605
605
**offset** | **Number**| Index of the first document of the page | [optional][default to 0]
606
-
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
606
+
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
607
607
608
608
### Return type
609
609
@@ -640,7 +640,7 @@ var apiInstance = new SibApiV3Sdk.ContactsApi();
640
640
var listId =789; // Number | Id of the list
641
641
642
642
var opts = {
643
-
'modifiedSince':newDate("2013-10-20T19:20:30+01:00"), // Date | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
643
+
'modifiedSince':newDate("2013-10-20T19:20:30+01:00"), // Date | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
644
644
'limit':50, // Number | Number of documents per page
645
645
'offset':0// Number | Index of the first document of the page
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
660
+
**modifiedSince** | **Date**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
661
661
**limit** | **Number**| Number of documents per page | [optional][default to 50]
662
662
**offset** | **Number**| Index of the first document of the page | [optional][default to 0]
Copy file name to clipboardExpand all lines: docs/CreateContact.md
+1
Original file line number
Diff line number
Diff line change
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
9
9
**smsBlacklisted** | **Boolean** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
10
10
**listIds** | **[Number]** | Ids of the lists to add the contact to | [optional]
11
11
**updateEnabled** | **Boolean** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional][default to false]
12
+
**smtpBlacklistSender** | **[String]** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
Copy file name to clipboardExpand all lines: docs/CreateEmailCampaign.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
8
8
**name** | **String** | Name of the campaign |
9
9
**htmlContent** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
10
10
**htmlUrl** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
11
-
**scheduledAt** | **Date** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
11
+
**scheduledAt** | **Date** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
12
12
**subject** | **String** | Subject of the campaign |
13
13
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
14
14
**toField** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME][LNAME]. These attributes must already exist in your contact database | [optional]
**attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiffand rtf | [optional]
16
+
**attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
17
17
**inlineImageActivation** | **Boolean** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional][default to false]
18
18
**mirrorActive** | **Boolean** | Use true to enable the mirror link | [optional]
19
19
**recurring** | **Boolean** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional][default to false]
Copy file name to clipboardExpand all lines: docs/CreateSmsCampaign.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
7
7
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
8
8
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional]
**scheduledAt** | **Date** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
10
+
**scheduledAt** | **Date** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
Copy file name to clipboardExpand all lines: docs/CreateSmtpTemplate.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
**subject** | **String** | Subject of the template |
12
12
**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional]
13
13
**toField** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME][LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional]
14
-
**attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiffand rtf | [optional]
14
+
**attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
15
15
**isActive** | **Boolean** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional]
Copy file name to clipboardExpand all lines: docs/EmailCampaignsApi.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@ All URIs are relative to *https://api.sendinblue.com/v3*
5
5
Method | HTTP request | Description
6
6
------------- | ------------- | -------------
7
7
[**createEmailCampaign**](EmailCampaignsApi.md#createEmailCampaign) | **POST** /emailCampaigns | Create an email campaign
8
-
[**deleteEmailCampaigns**](EmailCampaignsApi.md#deleteEmailCampaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
8
+
[**deleteEmailCampaign**](EmailCampaignsApi.md#deleteEmailCampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
9
9
[**emailExportRecipients**](EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
10
10
[**getEmailCampaign**](EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
11
11
[**getEmailCampaigns**](EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created campaigns
12
12
[**sendEmailCampaignNow**](EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
13
13
[**sendReport**](EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
14
14
[**sendTestEmail**](EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
15
15
[**updateCampaignStatus**](EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
16
-
[**updateEmailCampaigns**](EmailCampaignsApi.md#updateEmailCampaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
16
+
[**updateEmailCampaign**](EmailCampaignsApi.md#updateEmailCampaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
17
17
18
18
19
19
<aname="createEmailCampaign"></a>
@@ -64,9 +64,9 @@ Name | Type | Description | Notes
64
64
-**Content-Type**: application/json
65
65
-**Accept**: application/json
66
66
67
-
<aname="deleteEmailCampaigns"></a>
68
-
# **deleteEmailCampaigns**
69
-
> deleteEmailCampaigns(campaignId)
67
+
<aname="deleteEmailCampaign"></a>
68
+
# **deleteEmailCampaign**
69
+
> deleteEmailCampaign(campaignId)
70
70
71
71
Delete an email campaign
72
72
@@ -85,7 +85,7 @@ var apiInstance = new SibApiV3Sdk.EmailCampaignsApi();
85
85
86
86
var campaignId =789; // Number | id of the campaign
0 commit comments