To upload recipients to Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise), these recipients can be new or previously existing records. Make sure you refer to the recipient field limitation during upload.
Example
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"AddOrReplace": "Add",
"ContainsUnicode": true,
"Data":
"\"Custom_Member_Id\",\"First_Name\",\"Last_Name\",\"Email\",\"EP_3\",\"State\",\"Zip\",\"custom2\"
\n\"MyCustomMemberIDValue\",\"がんばっ\",\"M3\",\"test@higherlogic.com\",\"がんRSSD,LSばっ\",\"NO\",\"20902\",
\"Director, IT\"",
"GroupId": 1234567,
"HasHeaderRow": true,
"LoginId": 1234567,
"Mapping": [
{
"Key": 1,
"Value": "Custom_Member_Id"
},
{
"Key": 2,
"Value": "First_Name"
},
{
"Key": 3,
"Value": "Last_Name"
},
{
"Key": 4,
"Value": "Email"
},
{
"Key": 5,
"Value": "EP_3"
},
{
"Key": 6,
"Value": "State"
},
{
"Key": 7,
"Value": "Zip"
},
{
"Key": 8,
"Value": "custom2"
}
],
"UpdateExistingRecipients": true
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/UploadRecipients/
POST Parameters
NOTE: This call does not have conditional or optional parameters.
Required Parameters
| Parameter | Value | Description |
|---|---|---|
| SessionID | String | This is an authentication token which can be obtained by making the authenticate call. |
| UserID | String | The UserID returned in the authenticate call. |
| AddOrReplace | String | Determines whether you'd like to only add recipients to this group or replace them. In general, this should be set to Replace in order to create new recipients and ensure that your group in Thrive Marketing Enterprise is an accurate reflection of your data. |
| ContainsUnicode | Boolean | Does this upload contain Unicode characters? If your upload contains international characters, set this to true. |
| Data | String |
This is the information being uploaded to Thrive Marketing Enterprise.
EXAMPLE: \”Hello2,world\” |
| GroupID | Int | The ID of the pre-existing group in Thrive Marketing Enterprise. |
| HasHeaderRow | Boolean | Is there a header row for this upload? If your data contains commas that should exist in one field, this should be set to true. |
| LoginId | Int | The login ID for the user creating the upload. |
| Mapping | Array | This is the order of the mapping job. In the example above, Key 4 refers to column 4 of your data. In the example above, Key 4 should be uploaded to the field Email. Note that you require the field name and not the field label. For example, "custom2" is the name of the field in Thrive Marketing Enterprise even if the label is Title. |
| UpdateExistingRecipients | Boolean | Should the data be overwritten for existing records in Thrive Marketing Enterprise? |