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* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
115
115
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
116
116
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
117
117
*SibApiV3Sdk::EmailCampaignsApi* | [**send_email_campaign_now**](docs/EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
118
118
*SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
119
119
*SibApiV3Sdk::EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
120
120
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
121
-
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaigns**](docs/EmailCampaignsApi.md#update_email_campaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
121
+
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
122
122
*SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
123
123
*SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
*SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
147
147
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
151
151
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
152
152
*SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
limit:50, # Integer | Number of documents per page
629
629
offset:0, # Integer | Index of the first document of the page
630
-
modified_since:DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
630
+
modified_since:DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | 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.
631
631
}
632
632
633
633
begin
@@ -645,7 +645,7 @@ Name | Type | Description | Notes
**limit** | **Integer**| Number of documents per page | [optional][default to 50]
647
647
**offset** | **Integer**| Index of the first document of the page | [optional][default to 0]
648
-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
648
+
**modified_since** | **DateTime**| 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]
modified_since:DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
687
+
modified_since:DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | 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.
688
688
limit:50, # Integer | Number of documents per page
689
689
offset:0# Integer | Index of the first document of the page
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
706
+
**modified_since** | **DateTime**| 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]
707
707
**limit** | **Integer**| Number of documents per page | [optional][default to 50]
708
708
**offset** | **Integer**| Index of the first document of the page | [optional][default to 0]
Copy file name to clipboardExpand all lines: docs/CreateContact.md
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
9
9
**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
10
10
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
11
11
**update_enabled** | **BOOLEAN** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional][default to false]
12
+
**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
**html_content** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
10
10
**html_url** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
11
-
**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
11
+
**scheduled_at** | **DateTime** | 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
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
14
-
**to_field** | **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]
14
+
**to_field** | **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]
**attachment_url** | **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
+
**attachment_url** | **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
**inline_image_activation** | **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
**mirror_active** | **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-1Lines changed: 1 addition & 1 deletion
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]
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
10
+
**scheduled_at** | **DateTime** | 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]
**template_name** | **String** | Name of the template |
9
9
**html_content** | **String** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional]
10
10
**html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
11
11
**subject** | **String** | Subject of the template |
12
12
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
13
-
**to_field** | **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
-
**attachment_url** | **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]
13
+
**to_field** | **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
+
**attachment_url** | **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
**is_active** | **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-10Lines changed: 10 additions & 10 deletions
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
[**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
8
-
[**delete_email_campaigns**](EmailCampaignsApi.md#delete_email_campaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
8
+
[**delete_email_campaign**](EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
9
9
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
10
10
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
11
11
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
12
12
[**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
13
13
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
14
14
[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
15
15
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
16
-
[**update_email_campaigns**](EmailCampaignsApi.md#update_email_campaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
16
+
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
17
17
18
18
19
19
# **create_email_campaign**
@@ -68,8 +68,8 @@ Name | Type | Description | Notes
68
68
69
69
70
70
71
-
# **delete_email_campaigns**
72
-
> delete_email_campaigns(campaign_id)
71
+
# **delete_email_campaign**
72
+
> delete_email_campaign(campaign_id)
73
73
74
74
Delete an email campaign
75
75
@@ -92,9 +92,9 @@ campaign_id = 789 # Integer | id of the campaign
92
92
93
93
begin
94
94
#Delete an email campaign
95
-
api_instance.delete_email_campaigns(campaign_id)
95
+
api_instance.delete_email_campaign(campaign_id)
96
96
rescueSibApiV3Sdk::ApiError => e
97
-
puts"Exception when calling EmailCampaignsApi->delete_email_campaigns: #{e}"
97
+
puts"Exception when calling EmailCampaignsApi->delete_email_campaign: #{e}"
**lists** | [**Array<GetCampaignRecipientsLists>**](GetCampaignRecipientsLists.md) | Lists included in the campaign |
7
-
**exclusion_lists** | [**Array<GetCampaignRecipientsExclusionLists>**](GetCampaignRecipientsExclusionLists.md) | Lists excluded of the campaign |
0 commit comments