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
Copy file name to clipboardExpand all lines: docs/Api/SMSCampaignsApi.md
+6-2Lines changed: 6 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -177,7 +177,7 @@ Name | Type | Description | Notes
177
177
[[Back to top]](#)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to Model list]](../../README.md#documentation-for-models)[[Back to README]](../../README.md)
Returns the informations for all your created SMS campaigns
183
183
@@ -198,11 +198,13 @@ $apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
198
198
$config
199
199
);
200
200
$status = "status_example"; // string | Status of campaign.
201
+
$startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
202
+
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
201
203
$limit = 500; // int | Number limitation for the result returned
202
204
$offset = 0; // int | Beginning point in the list to retrieve from.
**status** | **string**| Status of campaign. | [optional]
220
+
**startDate** | **\DateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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]
221
+
**endDate** | **\DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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]
218
222
**limit** | **int**| Number limitation for the result returned | [optional][default to 500]
219
223
**offset** | **int**| Beginning point in the list to retrieve from. | [optional][default to 0]
Copy file name to clipboardExpand all lines: docs/Model/CreateEmailCampaign.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
22
22
**footer** | **string** | Footer of the email campaign | [optional]
23
23
**header** | **string** | Header of the email campaign | [optional]
24
24
**utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
25
-
**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic' | [optional]
25
+
**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name'&'toField' | [optional]
26
26
27
27
[[Back to Model list]](../../README.md#documentation-for-models)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to README]](../../README.md)
**sender** | **string** | Name of the sender. The number of characters is limited to 11 |
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]
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 |
**scheduledAt** | [**\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]
**listIds** | **int[]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
7
-
**exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign |
7
+
**exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign | [optional]
8
8
9
9
[[Back to Model list]](../../README.md#documentation-for-models)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to README]](../../README.md)
Copy file name to clipboardExpand all lines: docs/Model/GetAggregatedReport.md
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
15
15
**spamReports** | **int** | Number of complaint (spam report) for the timeframe |
16
16
**blocked** | **int** | Number of blocked contact emails for the timeframe |
17
17
**invalid** | **int** | Number of invalid emails for the timeframe |
18
+
**unsubscribed** | **int** | Number of unsubscribed emails for the timeframe |
18
19
19
20
[[Back to Model list]](../../README.md#documentation-for-models)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to README]](../../README.md)
Copy file name to clipboardExpand all lines: docs/Model/GetReportsReports.md
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
15
15
**spamReports** | **int** | Number of complaints (spam reports) for the date |
16
16
**blocked** | **int** | Number of blocked emails for the date |
17
17
**invalid** | **int** | Number of invalid emails for the date |
18
+
**unsubscribed** | **int** | Number of unsubscribed emails for the date |
18
19
19
20
[[Back to Model list]](../../README.md#documentation-for-models)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to README]](../../README.md)
0 commit comments