Page Comparison

...

What to know before start creating endpoint

...

Expand

title	Follow these few lines to understand which data you to a create recipient-related url....

Does your service need a Basic authentication?	Provide Username and Password using Credentials field.
Does your service need specific headers?	Provide key-value data using Headers field.
Does your service get the recipient using email or mobile number from the url?	You can use Recipient field, providing one of theses placeholders: [email] [mobilenumber] [fieldX] where X represent the dynamic content field unique identifier
Does your service get the recipient using data from the querystring?	You can use Parameters field, providing one of these placeholders: [email] [mobilenumber] [idconsole] [idlist] [idnl] [fieldX] where X represent the dynamic content field unique identifier

Description

Create a personalization endpoint configuration

HTTP Method

POST

URL

Code Block

language	xml

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/ConsolePersonalization/Endpoints

JSON request (example)

Expand

title	How to create an endpoint...

Code Block

title	Request body

{
	"Label":"Test",
	"Url": "https://www.mailup.com/personalization"
}

Code Block

title	HTTP Request:

 GET https://www.mailup.com/personalization

Expand

title	How to create an endpoint with credentials...

Code Block

title	Request body:

{
	"Label":"Test",
	"Url": "https://www.mailup.com/personalization",
	"Credentials": {
		"Username": "test",
		"Password": "test"
	}
}

Code Block

title	HTTP Request:

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

title	HTTP Request:

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

title	HTTP Request:

GET https://www.mailup.com/personalization/[mobilenumber]
Authentication: Basic dGVzdDp0ZXN0

Expand

title	How to create an endpoint with headers...

Code Block

title	Request body:

{
	"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

title	HTTP Request:

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

title	Request body:

 {
	"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

title	HTTP Request:

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

...

Versions Compared

Old Version 5

New Version 6

Key

What to know before start creating endpoint