Update the tracking link configuration of a mailing
1 min
POST
https://api.campaign.episerver.net/rest/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}
Path Parameters
- clientIdinteger<int64>requiredDescriptionFormatint64
- trackingLinkIdinteger<int64>requiredDescriptionFormatint64
- confirmationMailIdinteger<int64>requiredDescriptionFormatint64
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/jsonapplication/vnd.optivo.broadmail.v1+json
Form Parameters
- htmlTrackingstring<DEFAULT | ENABLED | DISABLED>DescriptionAllowedDEFAULTENABLEDDISABLED
- textTrackingstring<DEFAULT | ENABLED | DISABLED>DescriptionAllowedDEFAULTENABLEDDISABLED
- clickProfileIdsinteger[]Description
- descriptionstringDescription
Responses
200
- RestTrackingLink
- idinteger<int64>DescriptionFormatint64
- urlstringDescription
- htmlTrackingstring<DEFAULT | ENABLED | DISABLED>DescriptionAllowedDEFAULTENABLEDDISABLED
- textTrackingstring<DEFAULT | ENABLED | DISABLED>DescriptionAllowedDEFAULTENABLEDDISABLED
- descriptionstringDescription
- htmlOccurrencesinteger<int32>DescriptionFormatint32
- textOccurrencesinteger<int32>DescriptionFormatint32
- clickProfileIdsinteger[]Description
- linksobject[]Description
- uriBuilderobject
- relsstring[]
- relstring
- typestring
- paramsmap<string, string>
- titlestring
- uristring<uri>Formaturi
curl
curl --request POST \
--url https://api.campaign.episerver.net/rest/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/x-www-form-urlencoded");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.campaign.episerver.net/rest/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "net/http"
url = URI("https://api.campaign.episerver.net/rest/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/x-www-form-urlencoded"
response = https.request(request)
puts response.read_body
python
import requests
url = "https://api.campaign.episerver.net/rest/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/x-www-form-urlencoded'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// The tracking link configuration was updated successfully.
{
"id": "",
"url": "",
"htmlTracking": "",
"textTracking": "",
"description": "",
"htmlOccurrences": "",
"textOccurrences": "",
"clickProfileIds": [
0
],
"links": [
{
"uriBuilder": {},
"rels": [
""
],
"rel": "",
"type": "",
"params": "",
"title": "",
"uri": ""
}
]
}