@@ -209,7 +209,7 @@ public function getCampaignsV2($data)
209
209
@options data {String} reply_to: The reply to email in the campaign emails [Optional]
210
210
@options data {String} to_field: This is to personalize the «To» Field. If you want to
211
211
include the first name and last name of your recipient, add [PRENOM] [NOM] To use the contact
212
- attributes here, these should already exist in SendinBlue account [Optional]
212
+ attributes here, these should already exist in Sendinblue account [Optional]
213
213
@options data {Array} exclude_list: These are the lists which must be excluded from the campaign [Optional]
214
214
@options data {String} attachment_url: Provide the absolute url of the attachment [Optional]
215
215
@options data {Integer} inline_image: Status of inline image. Possible values = 0 (default)
@@ -254,7 +254,7 @@ public function createCampaign($data)
254
254
@options data {String} reply_to: The reply to email in the campaign emails [Optional]
255
255
@options data {String} to_field: This is to personalize the «To» Field. If you want to
256
256
include the first name and last name of your recipient, add [PRENOM] [NOM]. To use the
257
- contact attributes here, these should already exist in SendinBlue account [Optional]
257
+ contact attributes here, these should already exist in Sendinblue account [Optional]
258
258
@options data {Array} exclude_list: These are the lists which must be excluded from the
259
259
campaign [Optional]
260
260
@options data {String} attachment_url: Provide the absolute url of the attachment [Optional]
@@ -393,7 +393,7 @@ public function updateCampaignStatus($data)
393
393
@options data {String} reply_to: The reply to email in the campaign emails [Optional]
394
394
@options data {String} to_field: This is to personalize the «To» Field. If you want to include
395
395
the first name and last name of your recipient, add [PRENOM] [NOM]. To use the contact attributes
396
- here, these should already exist in SendinBlue account [Optional]
396
+ here, these should already exist in Sendinblue account [Optional]
397
397
@options data {Array} exclude_list: These are the lists which must be excluded from the campaign
398
398
[Optional]
399
399
@options data {Integer} recurring: Type of trigger campaign. Possible values = 0 (default) & 1.
@@ -439,7 +439,7 @@ public function createTriggerCampaign($data)
439
439
@options data {String} reply_to: The reply to email in the campaign emails [Optional]
440
440
@options data {String} to_field: This is to personalize the «To» Field. If you want to include the
441
441
first name and last name of your recipient, add [PRENOM] [NOM]. To use the contact attributes here
442
- , these should already exist in SendinBlue account [Optional]
442
+ , these should already exist in Sendinblue account [Optional]
443
443
@options data {Array} exclude_list: These are the lists which must be excluded from the campaign
444
444
[Optional]
445
445
@options data {Integer} recurring: Type of trigger campaign. Possible values = 0 (default) & 1.
@@ -594,11 +594,11 @@ public function displayListUsers($data)
594
594
}
595
595
596
596
/*
597
- Add already existing users in the SendinBlue contacts to the list.
597
+ Add already existing users in the Sendinblue contacts to the list.
598
598
@param {Array} data contains php array with key value pair.
599
599
@options data {Integer} id: Id of list to link users in it [Mandatory]
600
600
@options data {Array} users: Email address of the already existing user(s) in the
601
- SendinBlue contacts. Example: "test@example.net". You can use commas to separate multiple
601
+ Sendinblue contacts. Example: "test@example.net". You can use commas to separate multiple
602
602
users [Mandatory]
603
603
*/
604
604
@@ -610,11 +610,11 @@ public function addUsersList($data)
610
610
}
611
611
612
612
/*
613
- Delete already existing users in the SendinBlue contacts from the list.
613
+ Delete already existing users in the Sendinblue contacts from the list.
614
614
@param {Array} data contains php array with key value pair.
615
615
@options data {Integer} id: Id of list to unlink users from it [Mandatory]
616
616
@options data {Array} users: Email address of the already existing user(s) in the
617
- SendinBlue contacts to be modified. Example: "test@example.net". You can use commas
617
+ Sendinblue contacts to be modified. Example: "test@example.net". You can use commas
618
618
to separate multiple users [Mandatory]
619
619
*/
620
620
public function deleteUsersList ($ data )
@@ -650,7 +650,7 @@ public function getAttribute($data)
650
650
@options data {String} type: Type of attribute. Possible values – normal, transactional,
651
651
category, calculated & global ( case sensitive ) [Mandatory]
652
652
@options data {Array} data: The name and data type of ‘normal’ & ‘transactional’ attribute
653
- to be created in your SendinBlue account. It should be sent as an associative array. Example:
653
+ to be created in your Sendinblue account. It should be sent as an associative array. Example:
654
654
array(‘ATTRIBUTE_NAME1′ => ‘DATA_TYPE1′, ‘ATTRIBUTE_NAME2’=> ‘DATA_TYPE2′).
655
655
The name and data value of ‘category’, ‘calculated’ & ‘global’, should be sent as JSON string.
656
656
Example: ‘[{ "name":"ATTRIBUTE_NAME1", "value":"Attribute_value1" }, { "name":"ATTRIBUTE_NAME2",
@@ -675,11 +675,11 @@ public function deleteAttribute($type, $data)
675
675
676
676
/*
677
677
Create a new user if an email provided as input, doesn’t exists in the contact list
678
- of your SendinBlue account, otherwise it will update the existing user.
678
+ of your Sendinblue account, otherwise it will update the existing user.
679
679
@param {Array} data contains php array with key value pair.
680
- @options data {String} email: Email address of the user to be created in SendinBlue contacts.
681
- Already existing email address of user in the SendinBlue contacts to be modified [Mandatory]
682
- @options data {Array} attributes: The name of attribute present in your SendinBlue account.
680
+ @options data {String} email: Email address of the user to be created in Sendinblue contacts.
681
+ Already existing email address of user in the Sendinblue contacts to be modified [Mandatory]
682
+ @options data {Array} attributes: The name of attribute present in your Sendinblue account.
683
683
It should be sent as an associative array. Example: array("NAME"=>"name"). You can use commas
684
684
to separate multiple attributes [Optional]
685
685
@options data {Integer} blacklisted: This is used to blacklist/ Unblacklist a user. Possible
@@ -698,7 +698,7 @@ public function createUpdateUser($data)
698
698
/*
699
699
Get Access a specific user Information.
700
700
@param {Array} data contains php array with key value pair.
701
- @options data {String} email: Email address of the already existing user in the SendinBlue
701
+ @options data {String} email: Email address of the already existing user in the Sendinblue
702
702
contacts [Mandatory]
703
703
*/
704
704
public function getUser ($ data )
@@ -709,7 +709,7 @@ public function getUser($data)
709
709
/*
710
710
Unlink existing user from all lists.
711
711
@param {Array} data contains php array with key value pair.
712
- @options data {String} email: Email address of the already existing user in the SendinBlue
712
+ @options data {String} email: Email address of the already existing user in the Sendinblue
713
713
contacts to be unlinked from all lists [Mandatory]
714
714
*/
715
715
public function deleteUser ($ data )
@@ -743,7 +743,7 @@ public function importUsers($data)
743
743
/*
744
744
Export Users Information.
745
745
@param {Array} data contains php array with key value pair.
746
- @options data {String} export_attrib: The name of attribute present in your SendinBlue account.
746
+ @options data {String} export_attrib: The name of attribute present in your Sendinblue account.
747
747
You can use commas to separate multiple attributes. Example: "EMAIL,NAME,SMS" [Optional]
748
748
@options data {String} filter: Filter can be added to export users. Example: "{\"blacklisted\":1}",
749
749
will export all blacklisted users [Mandatory]
@@ -934,7 +934,7 @@ public function sendEmail($data)
934
934
}
935
935
936
936
/*
937
- Aggregate / date-wise report of the SendinBlue SMTP account.
937
+ Aggregate / date-wise report of the Sendinblue SMTP account.
938
938
@param {Array} data contains php array with key value pair.
939
939
@options data {Integer} aggregate: This is used to indicate, you are interested in all-time totals.
940
940
Possible values – 0 & 1. aggregate = 0 means it will not aggregate records, and will show stats per
@@ -990,15 +990,15 @@ public function deleteBounces($data)
990
990
}
991
991
992
992
/*
993
- Send templates created on SendinBlue , through SendinBlue SMTP (transactional mails).
993
+ Send templates created on Sendinblue , through Sendinblue SMTP (transactional mails).
994
994
@param {Array} data contains php array with key value pair.
995
- @options data {Integer} id: Id of the template created on SendinBlue account [Mandatory]
995
+ @options data {Integer} id: Id of the template created on Sendinblue account [Mandatory]
996
996
@options data {String} to: Email address of the recipient(s). You can use pipe ( | )
997
997
to separate multiple recipients. Example: "to-example@example.net|to2-example@example.net"
998
998
[Mandatory]
999
999
@options data {String} cc: Same as to but for Cc [Optional]
1000
1000
@options data {String} bcc: Same as to but for Bcc [Optional]
1001
- @options data {Array} attrv The name of attribute present in your SendinBlue account. It should
1001
+ @options data {Array} attrv The name of attribute present in your Sendinblue account. It should
1002
1002
be sent as an associative array. Example: array("NAME"=>"name"). You can use commas to separate
1003
1003
multiple attributes [Optional]
1004
1004
@options data {String} attachment_url: Provide the absolute url of the attachment. Url not allowed
@@ -1030,7 +1030,7 @@ public function sendTransactionalTemplate($data)
1030
1030
@options data {String} reply_to: The reply to email in the campaign emails [Optional]
1031
1031
@options data {String} to_fieldv This is to personalize the «To» Field. If you want to include
1032
1032
the first name and last name of your recipient, add [PRENOM] [NOM]. To use the contact attributes
1033
- here, these should already exist in SendinBlue account [Optional]
1033
+ here, these should already exist in Sendinblue account [Optional]
1034
1034
@options data {Integer} status: Status of template. Possible values = 0 (default) & 1. status = 0
1035
1035
means template is inactive, & status = 1 means template is active [Optional]
1036
1036
@options data {Integer} attachment: Status of attachment. Possible values = 0 (default) & 1.
@@ -1060,7 +1060,7 @@ public function createTemplate($data)
1060
1060
@options data {String} reply_to: The reply to email in the campaign emails [Optional]
1061
1061
@options data {String} to_field: This is to personalize the «To» Field. If you want to include the
1062
1062
first name and last name of your recipient, add [PRENOM] [NOM]. To use the contact attributes here,
1063
- these should already exist in SendinBlue account [Optional]
1063
+ these should already exist in Sendinblue account [Optional]
1064
1064
@options data {Integer} status: Status of template. Possible values = 0 (default) & 1. status = 0
1065
1065
means template is inactive, & status = 1 means template is active [Optional]
1066
1066
@options data {Integer} attachment: Status of attachment. Possible values = 0 (default) & 1.
@@ -1103,7 +1103,7 @@ public function sendSms($data)
1103
1103
@options data {String} content: Content of the message. The maximum characters used per SMS is 160,
1104
1104
if used more than that, it will be counted as more than one SMS [Optional]
1105
1105
@options data {String} bat: Mobile number with the country code to send test SMS. The mobile number
1106
- defined here should belong to one of your contacts in SendinBlue account and should not be blacklisted
1106
+ defined here should belong to one of your contacts in Sendinblue account and should not be blacklisted
1107
1107
[Optional]
1108
1108
@options data {Array} listid: These are the list ids to which the SMS campaign is sent [Mandatory: if
1109
1109
scheduled_date is not empty]
@@ -1129,7 +1129,7 @@ public function createSmsCampaign($data)
1129
1129
@options data {String} content: Content of the message. The maximum characters used per SMS is 160,
1130
1130
if used more than that, it will be counted as more than one SMS [Optional]
1131
1131
@options data {String} bat: Mobile number with the country code to send test SMS. The mobile number
1132
- defined here should belong to one of your contacts in SendinBlue account and should not be blacklisted
1132
+ defined here should belong to one of your contacts in Sendinblue account and should not be blacklisted
1133
1133
[Optional]
1134
1134
@options data {Array} listid: hese are the list ids to which the SMS campaign is sent [Mandatory: if
1135
1135
scheduled_date is not empty]
@@ -1152,7 +1152,7 @@ public function updateSmsCampaign($data)
1152
1152
@param {Array} data contains php array with key value pair.
1153
1153
@options data {Integer} id: Id of the SMS campaign [Mandatory]
1154
1154
@options data {String} to: Mobile number with the country code to send test SMS. The mobile
1155
- number defined here should belong to one of your contacts in SendinBlue account and should not be
1155
+ number defined here should belong to one of your contacts in Sendinblue account and should not be
1156
1156
blacklisted [Mandatory]
1157
1157
*/
1158
1158
public function sendBatSms ($ data )
0 commit comments