| Info |
|---|
Personalization is an advanced feature and it is not enabled by default for every platform. Are you interested in? Would you like your newsletter provides contents keeping data from an external data source including conditional logic and loops? Please, contact MailUp API team for further information. |
The personalization engine allows to provide newsletters contents using Liquid template. If you can provide recipient-related JSON information via a web service, you could use this feature to personalize your newsletter. When MailUp will send your newsletter, it will call your web service and retrieve the personalized information per recipient. To reach a specified recipient the personalization engine will create an url that contains recipent-related data that you'll define creating a personalization endpoint configuration. So, let's create your first personalization endpoint!
This page provides you information about how to manage pensonalization's endpoints.
...
| Description | Retrieve the personalization endpoint configuration details |
|---|
HTTP Method | GET |
|---|
| URL | | Code Block |
|---|
| https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/ConsolePersonalization/Endpoints/{id_endpoint} |
|
|---|
| JSON request (example) | none |
|---|
| JSON response (example) | | Expand |
|---|
| Code Block |
|---|
{
"CreationDate": "2017-12-01 11:20:19Z",
"IdEndpoint": 11,
"Label": "My personalization",
"Url": "https://www.mailup.com/personalization",
"Credentials": {
"Password": "****",
"Username": "test"
},
"Headers": [],
"Parameters": [
{
"Field": "[field1]",
"FieldTestValue": "Giancarlo",
"Name": "name"
}
],
"Recipient": {
"Field": "[email]",
"FieldTestValue": "test@example.com"
},
"UpdateDate": "2017-12-01 11:25:37Z"
} |
|
|
|---|
| Paging and filtering (example) | none |
|---|
Create an endpoint
What to know before start creating endpoint
| Description | Create a personalization endpoint configuration |
|---|
HTTP Method | POST |
|---|
| URL | | Code Block |
|---|
| https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/ConsolePersonalization/Endpoints |
|
|---|
| JSON request (example) | | Expand |
|---|
| title | How to create an endpoint... |
|---|
| | Code Block |
|---|
| {
"Label":"Test",
"Url": "https://www.mailup.com/personalization"
} |
| Code Block |
|---|
| GET https://www.mailup.com/personalization |
|
| Expand |
|---|
| title | How to create an endpoint with credentials... |
|---|
| | Code Block |
|---|
| {
"Label":"Test",
"Url": "https://www.mailup.com/personalization",
"Credentials": {
"Username": "test",
"Password": "test"
}
} |
| Code Block |
|---|
| GET https://www.mailup.com/personalization
Authentication: Basic dGVzdDp0ZXN0 |
|
| Expand |
|---|
| title | How to create an endpoint with recipient definition... |
|---|
| | Code Block |
|---|
| title | Recipient's email definition request body: |
|---|
| {
"Label":"Test",
"Url": "https://www.mailup.com/personalization",
"Credentials": {
"Username": "test",
"Password": "test"
},
"Recipient": {
"Field":"[email]",
"FieldTestValue":"test@example.com"
}
} |
| Code Block |
|---|
| GET https://www.mailup.com/personalization/[email]
Authentication: Basic dGVzdDp0ZXN0 |
| Code Block |
|---|
| title | Recipient's phone number definition request body: |
|---|
| {
"Label":"Test",
"Url": "https://www.mailup.com/personalization",
"Credentials": {
"Username": "test",
"Password": "test"
},
"Recipient": {
"Field":"[mobilenumber]",
"FieldTestValue":"1234567890"
}
} |
| Code Block |
|---|
| GET https://www.mailup.com/personalization/[mobilenumber]
Authentication: Basic dGVzdDp0ZXN0 |
|
| Expand |
|---|
| title | How to create an endpoint with headers... |
|---|
| | Code Block |
|---|
| {
"Label":"Test",
"Url": "https://www.mailup.com/personalization",
"Credentials": {
"Username": "test",
"Password": "test"
},
"Recipient": {
"Field":"[email]",
"FieldTestValue":"test@example.com"
},
"Headers": [{
"Key": "From",
"Value": "personalization@example.com"
}]
} |
| Code Block |
|---|
| GET https://www.mailup.com/personalization/[email]
Authentication: Basic dGVzdDp0ZXN0
From: personalization@example.com |
|
| Expand |
|---|
| title | How to create an endpoint with querystring parameters... |
|---|
| | Code Block |
|---|
| {
"Label":"Test",
"Url": "https://www.mailup.com/personalization",
"Credentials": {
"Username": "test",
"Password": "test"
},
"Recipient": {
"Field":"[email]",
"FieldTestValue":"test@example.com"
},
"Headers": [{
"Key": "From",
"Value": "personalization@example.com"
}],
"Parameters": [{
"Name": "idconsole",
"Field": "[idconsole]",
"FieldTestValue": "1234"
},{
"Name": "const",
"Field": "1234",
"FieldTestValue": "1234"
}]
} |
| Code Block |
|---|
| GET https://www.mailup.com/personalization/[email]?idconsole=[idconsole]&const=1234
Authentication: Basic dGVzdDp0ZXN0
From: personalization@example.com |
|
|
|---|
| JSON response (example) | | Expand |
|---|
| Code Block |
|---|
{
"CreationDate": "2017-12-03 11:20:19Z",
"IdEndpoint": 12,
"Label": "My personalization",
"Url": "https://www.mailup.com/personalization",
"Credentials": {
"Password": "",
"Username": ""
},
"Headers": [],
"Parameters": [
{
"Name":"IdNl",
"Field":"[idnl]",
"FieldTestValue":"123"
}
],
"Recipient": {
"Field":"[email]",
"FieldTestValue": "test@example.com"
},
"UpdateDate": "2017-12-03 11:25:37Z"
} |
|
|
|---|
| Paging and filtering (example) | none |
|---|
...