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
String identifier ="identifier_example"; // String | Email (urlencoded) OR ID of the contact
773
-
LocalDate startDate =LocalDate.now(); //LocalDate | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
774
-
LocalDate endDate =LocalDate.now(); //LocalDate | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
773
+
String startDate ="startDate_example"; //String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
774
+
String endDate ="endDate_example"; //String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
775
775
try {
776
776
GetContactCampaignStats result = apiInstance.getContactStats(identifier, startDate, endDate);
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
789
-
**startDate** | **LocalDate**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
790
-
**endDate** | **LocalDate**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
789
+
**startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
790
+
**endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
Long limit =50L; // Long | Number of documents per page
836
836
Long offset =0L; // Long | Index of the first document of the page
837
-
OffsetDateTime modifiedSince =OffsetDateTime.now(); //OffsetDateTime | 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.
838
-
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation
837
+
String modifiedSince ="modifiedSince_example"; //String | 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.
838
+
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
839
839
try {
840
840
GetContacts result = apiInstance.getContacts(limit, offset, modifiedSince, sort);
841
841
System.out.println(result);
@@ -851,8 +851,8 @@ Name | Type | Description | Notes
**limit** | **Long**| Number of documents per page | [optional][default to 50]
853
853
**offset** | **Long**| Index of the first document of the page | [optional][default to 0]
854
-
**modifiedSince** | **OffsetDateTime**| 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]
855
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional][default to desc][enum: asc, desc]
854
+
**modifiedSince** | **String**| 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]
855
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional][default to desc][enum: asc, desc]
OffsetDateTime modifiedSince =OffsetDateTime.now(); //OffsetDateTime | 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.
901
+
String modifiedSince ="modifiedSince_example"; //String | 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.
902
902
Long limit =50L; // Long | Number of documents per page
903
903
Long offset =0L; // Long | Index of the first document of the page
904
-
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation
904
+
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
905
905
try {
906
906
GetContacts result = apiInstance.getContactsFromList(listId, modifiedSince, limit, offset, sort);
**modifiedSince** | **OffsetDateTime**| 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]
919
+
**modifiedSince** | **String**| 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]
920
920
**limit** | **Long**| Number of documents per page | [optional][default to 50]
921
921
**offset** | **Long**| Index of the first document of the page | [optional][default to 0]
922
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional][default to desc][enum: asc, desc]
922
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional][default to desc][enum: asc, desc]
923
923
924
924
### Return type
925
925
@@ -1026,7 +1026,7 @@ ContactsApi apiInstance = new ContactsApi();
1026
1026
Long folderId =789L; // Long | Id of the folder
1027
1027
Long limit =10L; // Long | Number of documents per page
1028
1028
Long offset =0L; // Long | Index of the first document of the page
1029
-
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation
1029
+
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1030
1030
try {
1031
1031
GetFolderLists result = apiInstance.getFolderLists(folderId, limit, offset, sort);
1032
1032
System.out.println(result);
@@ -1043,7 +1043,7 @@ Name | Type | Description | Notes
1043
1043
**folderId** | **Long**| Id of the folder |
1044
1044
**limit** | **Long**| Number of documents per page | [optional][default to 10]
1045
1045
**offset** | **Long**| Index of the first document of the page | [optional][default to 0]
1046
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional][default to desc][enum: asc, desc]
1046
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional][default to desc][enum: asc, desc]
Long limit =10L; // Long | Number of documents per page
1092
1092
Long offset =0L; // Long | Index of the first document of the page
1093
-
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation
1093
+
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1094
1094
try {
1095
1095
GetFolders result = apiInstance.getFolders(limit, offset, sort);
1096
1096
System.out.println(result);
@@ -1106,7 +1106,7 @@ Name | Type | Description | Notes
**limit** | **Long**| Number of documents per page | [default to 10]
1108
1108
**offset** | **Long**| Index of the first document of the page | [default to 0]
1109
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional][default to desc][enum: asc, desc]
1109
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional][default to desc][enum: asc, desc]
Long limit =10L; // Long | Number of documents per page
1214
1214
Long offset =0L; // Long | Index of the first document of the page
1215
-
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation
1215
+
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1216
1216
try {
1217
1217
GetLists result = apiInstance.getLists(limit, offset, sort);
1218
1218
System.out.println(result);
@@ -1228,7 +1228,7 @@ Name | Type | Description | Notes
**limit** | **Long**| Number of documents per page | [optional][default to 10]
1230
1230
**offset** | **Long**| Index of the first document of the page | [optional][default to 0]
1231
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional][default to desc][enum: asc, desc]
1231
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional][default to desc][enum: asc, desc]
Copy file name to clipboardExpand all lines: docs/CreateEmailCampaign.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
**htmlContent** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
11
11
**htmlUrl** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
12
12
**templateId** | **Long** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
13
-
**scheduledAt** | [**OffsetDateTime**] | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
13
+
**scheduledAt** | **String** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
14
14
**subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
15
15
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
16
16
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
Copy file name to clipboardExpand all lines: docs/CreateSmsCampaign.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
9
9
**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 |
**scheduledAt** | [**OffsetDateTime**] | 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]
11
+
**scheduledAt** | **String** | 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]
String type ="type_example"; // String | Filter on the type of the campaigns
351
351
String status ="status_example"; // String | Filter on the status of the campaign
352
-
OffsetDateTime startDate =OffsetDateTime.now(); //OffsetDateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' )
353
-
OffsetDateTime endDate =OffsetDateTime.now(); //OffsetDateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' )
352
+
String startDate ="startDate_example"; //String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' )
353
+
String endDate ="endDate_example"; //String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' )
354
354
Long limit =500L; // Long | Number of documents per page
355
355
Long offset =0L; // Long | Index of the first document in the page
356
-
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation
356
+
String sort ="desc"; // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
357
357
try {
358
358
GetEmailCampaigns result = apiInstance.getEmailCampaigns(type, status, startDate, endDate, limit, offset, sort);
359
359
System.out.println(result);
@@ -369,11 +369,11 @@ Name | Type | Description | Notes
**type** | **String**| Filter on the type of the campaigns | [optional][enum: classic, trigger]
371
371
**status** | **String**| Filter on the status of the campaign | [optional][enum: suspended, archive, sent, queued, draft, inProcess]
372
-
**startDate** | **OffsetDateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' ) | [optional]
373
-
**endDate** | **OffsetDateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' ) | [optional]
372
+
**startDate** | **String**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' ) | [optional]
373
+
**endDate** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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' ) | [optional]
374
374
**limit** | **Long**| Number of documents per page | [optional][default to 500]
375
375
**offset** | **Long**| Index of the first document in the page | [optional][default to 0]
376
-
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional][default to desc][enum: asc, desc]
376
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional][default to desc][enum: asc, desc]
0 commit comments