Skip to content

Commit 65305c8

Browse files
Amit JoshiAmit Joshi
Amit Joshi
authored and
Amit Joshi
committed
update docs
1 parent 3553792 commit 65305c8

File tree

5 files changed

+22
-22
lines changed

5 files changed

+22
-22
lines changed

‎docs/GetCampaignOverview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **Long** | ID of the campaign |
88
**name** | **String** | Name of the campaign |
9-
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
9+
**subject** | **String** | Subject of the campaign. Only available if 'abTesting' flag of the campaign is 'false' | [optional]
1010
**type** | [**TypeEnum**](#TypeEnum) | Type of campaign |
1111
**status** | [**StatusEnum**](#StatusEnum) | Status of the campaign |
1212
**scheduledAt** | [**OffsetDateTime**] | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1313
**abTesting** | **Boolean** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
14-
**subjectA** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
15-
**subjectB** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
16-
**splitRule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
17-
**winnerCriteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
18-
**winnerDelay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional]
14+
**subjectA** | **String** | Subject A of the ab-test campaign. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
15+
**subjectB** | **String** | Subject B of the ab-test campaign. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
16+
**splitRule** | **Integer** | The size of your ab-test groups. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
17+
**winnerCriteria** | **String** | Criteria for the winning version. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
18+
**winnerDelay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
1919
**sendAtBestTime** | **Boolean** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
2020

2121

‎docs/GetEmailCampaign.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **Long** | ID of the campaign |
88
**name** | **String** | Name of the campaign |
9-
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
9+
**subject** | **String** | Subject of the campaign. Only available if 'abTesting' flag of the campaign is 'false' | [optional]
1010
**type** | [**TypeEnum**](#TypeEnum) | Type of campaign |
1111
**status** | [**StatusEnum**](#StatusEnum) | Status of the campaign |
1212
**scheduledAt** | [**OffsetDateTime**] | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1313
**abTesting** | **Boolean** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
14-
**subjectA** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
15-
**subjectB** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
16-
**splitRule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
17-
**winnerCriteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
18-
**winnerDelay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional]
14+
**subjectA** | **String** | Subject A of the ab-test campaign. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
15+
**subjectB** | **String** | Subject B of the ab-test campaign. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
16+
**splitRule** | **Integer** | The size of your ab-test groups. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
17+
**winnerCriteria** | **String** | Criteria for the winning version. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
18+
**winnerDelay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
1919
**sendAtBestTime** | **Boolean** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
2020
**testSent** | **Boolean** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
2121
**header** | **String** | Header of the campaign |
2222
**footer** | **String** | Footer of the campaign |
2323
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
24-
**replyTo** | **String** | Email defined as the \"Reply to\" of the campaign |
25-
**toField** | **String** | Customisation of the \"to\" field of the campaign |
24+
**replyTo** | **String** | Email defined as the 'Reply to' of the campaign |
25+
**toField** | **String** | Customisation of the 'to' field of the campaign |
2626
**htmlContent** | **String** | HTML content of the campaign |
2727
**shareLink** | **String** | Link to share the campaign on social medias | [optional]
2828
**tag** | **String** | Tag of the campaign |

‎docs/GetExtendedCampaignOverview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **Long** | ID of the campaign |
88
**name** | **String** | Name of the campaign |
9-
**subject** | **String** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional]
9+
**subject** | **String** | Subject of the campaign. Only available if 'abTesting' flag of the campaign is 'false' | [optional]
1010
**type** | [**TypeEnum**](#TypeEnum) | Type of campaign |
1111
**status** | [**StatusEnum**](#StatusEnum) | Status of the campaign |
1212
**scheduledAt** | [**OffsetDateTime**] | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1313
**abTesting** | **Boolean** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional]
14-
**subjectA** | **String** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
15-
**subjectB** | **String** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional]
16-
**splitRule** | **Integer** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional]
17-
**winnerCriteria** | **String** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional]
18-
**winnerDelay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional]
14+
**subjectA** | **String** | Subject A of the ab-test campaign. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
15+
**subjectB** | **String** | Subject B of the ab-test campaign. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
16+
**splitRule** | **Integer** | The size of your ab-test groups. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
17+
**winnerCriteria** | **String** | Criteria for the winning version. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
18+
**winnerDelay** | **Integer** | The duration of the test in hours at the end of which the winning version will be sent. Only available if 'abTesting' flag of the campaign is 'true' | [optional]
1919
**sendAtBestTime** | **Boolean** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]
2020
**testSent** | **Boolean** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
2121
**header** | **String** | Header of the campaign |

‎docs/RequestContactImport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
1212
**emailBlacklist** | **Boolean** | To blacklist all the contacts for email | [optional]
1313
**smsBlacklist** | **Boolean** | To blacklist all the contacts for sms | [optional]
1414
**updateExistingContacts** | **Boolean** | To facilitate the choice to update the existing contacts | [optional]
15-
**emptyContactsAttributes** | **Boolean** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) | [optional]
15+
**emptyContactsAttributes** | **Boolean** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if 'updateExistingContacts' set to 'true' ) | [optional]
1616

1717

1818

‎docs/UpdateEmailCampaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
2121
**footer** | **String** | Footer of the email campaign | [optional]
2222
**header** | **String** | Header of the email campaign | [optional]
2323
**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]
24-
**params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
24+
**params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {"FNAME":"Joe", "LNAME":"Doe"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
2525
**sendAtBestTime** | **Boolean** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional]
2626
**abTesting** | **Boolean** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional]
2727
**subjectA** | **String** | Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional]

0 commit comments

Comments
 (0)