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
**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
8
-
**enumeration** | [**List<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional]
9
-
**type** | [**TypeEnum**](#TypeEnum) | Type of the attribute. Use only if the attribute's category is normal, category or transactional ( type 'id' only available if the category is 'transactional' attribute & type 'category' only available if the category is 'category' attribute ) | [optional]
7
+
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
8
+
**enumeration** | [**List<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
9
+
**type** | [**TypeEnum**](#TypeEnum) | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id'is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
**email** | **String** | Email address of the user. Mandatory if `attributes.sms`is not passed | [optional]
8
-
**attributes** | **Object** | Values of the attributes to fill. The attributes must exist in you contact database | [optional]
9
-
**emailBlacklisted** | **Boolean** | Blacklist the contact for emails (emailBlacklisted = true) | [optional]
10
-
**smsBlacklisted** | **Boolean** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
7
+
**email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional]
8
+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
9
+
**emailBlacklisted** | **Boolean** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
10
+
**smsBlacklisted** | **Boolean** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
11
11
**listIds** | **List<Long>** | Ids of the lists to add the contact to | [optional]
12
-
**updateEnabled** | **Boolean** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional]
12
+
**updateEnabled** | **Boolean** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional]
13
13
**smtpBlacklistSender** | **List<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
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
**name** | **String** | Name of the campaign |
10
10
**htmlContent** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
11
11
**htmlUrl** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
12
-
**scheduledAt** | [**OffsetDateTime**](OffsetDateTime.md) | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
12
+
**scheduledAt** | [**OffsetDateTime**] | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
13
13
**subject** | **String** | Subject of the campaign |
14
14
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
15
15
**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]
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 |
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 | [optional]
**scheduledAt** | [**OffsetDateTime**](OffsetDateTime.md) | 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** | [**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]
**startDate** | **LocalDate** | Starting date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be lower than equal to endDate | [optional]
8
-
**endDate** | **LocalDate** | Ending date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be greater than equal to startDate | [optional]
7
+
**startDate** | **LocalDate** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
8
+
**endDate** | **LocalDate** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
9
9
**contactEmail** | **String** | Target a specific email address | [optional]
Copy file name to clipboardExpand all lines: docs/GetAccountPlan.md
+2-3
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
7
7
**type** | [**TypeEnum**](#TypeEnum) | Displays the plan type of the user |
8
8
**creditsType** | [**CreditsTypeEnum**](#CreditsTypeEnum) | This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. |
9
9
**credits** | **Float** | Remaining credits of the user |
10
-
**startDate** | **LocalDate** | Date of the period from which the plan will start (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional]
11
-
**endDate** | **LocalDate** | Date of the period from which the plan will end (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional]
10
+
**startDate** | **LocalDate** | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional]
11
+
**endDate** | **LocalDate** | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional]
12
12
**userLimit** | **Integer** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional]
13
13
14
14
@@ -17,7 +17,6 @@ Name | Type | Description | Notes
Copy file name to clipboardExpand all lines: docs/GetEmailCampaign.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
**subject** | **String** | Subject of the campaign |
10
10
**type** | [**TypeEnum**](#TypeEnum) | Type of campaign |
11
11
**status** | [**StatusEnum**](#StatusEnum) | Status of the campaign |
12
-
**scheduledAt** | [**OffsetDateTime**](OffsetDateTime.md) | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
+
**scheduledAt** | [**OffsetDateTime**] | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
13
13
**testSent** | **Boolean** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
14
14
**header** | **String** | Header of the campaign |
15
15
**footer** | **String** | Footer of the campaign |
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
19
19
**htmlContent** | **String** | HTML content of the campaign |
20
20
**shareLink** | **String** | Link to share the campaign on social medias | [optional]
21
21
**tag** | **String** | Tag of the campaign |
22
-
**createdAt** | [**OffsetDateTime**](OffsetDateTime.md) | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
23
-
**modifiedAt** | [**OffsetDateTime**](OffsetDateTime.md) | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
22
+
**createdAt** | [**OffsetDateTime**] | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
23
+
**modifiedAt** | [**OffsetDateTime**] | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
24
24
**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
25
25
**mirrorActive** | **Boolean** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
26
26
**recurring** | **Boolean** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
Copy file name to clipboardExpand all lines: docs/GetExtendedCampaignOverview.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
**subject** | **String** | Subject of the campaign |
10
10
**type** | [**TypeEnum**](#TypeEnum) | Type of campaign |
11
11
**status** | [**StatusEnum**](#StatusEnum) | Status of the campaign |
12
-
**scheduledAt** | [**OffsetDateTime**](OffsetDateTime.md) | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
+
**scheduledAt** | [**OffsetDateTime**] | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
13
13
**testSent** | **Boolean** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
14
14
**header** | **String** | Header of the campaign |
15
15
**footer** | **String** | Footer of the campaign |
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
19
19
**htmlContent** | **String** | HTML content of the campaign |
20
20
**shareLink** | **String** | Link to share the campaign on social medias | [optional]
21
21
**tag** | **String** | Tag of the campaign |
22
-
**createdAt** | [**OffsetDateTime**](OffsetDateTime.md) | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
23
-
**modifiedAt** | [**OffsetDateTime**](OffsetDateTime.md) | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
22
+
**createdAt** | [**OffsetDateTime**] | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
23
+
**modifiedAt** | [**OffsetDateTime**] | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
24
24
**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
25
25
**mirrorActive** | **Boolean** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
26
26
**recurring** | **Boolean** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
0 commit comments