API / Link

Entity Description:

Link allows a user to track a hyper-link or track linked text in a PoliteMail tracked email message. Tracked links in an email will be saved to a Links repository in PoliteMail for future use. Links in the repository can be edited. By changing the actual URL associated with a link, it will redirect any future clicks from emails previously sent containing that tracked link.

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
ActiveState
Int16
Name
String
Description
String
Url
String
OwnerID
Int32
GUID
String
Shared
Boolean
CreationDate
DateTime
BusinessID
Int32
RegionID
Int32

Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a Link

Request

POST /api/odata/Links

Content-Type 

application/json

Request body

{
"ID":"0","ActiveState":"1","Name":"New Link","Description":
"Example Description","Url":"Example URL","OwnerID":"0","GUID":"0","Shared":false,"CreationDate":"2014-11-19T11:23:24.165Z","BusinessID":"0","RegionID":"0"
}

Response body

{
"ID":1,"ActiveState":1,"Name":"New Link","Description":
"Example Description","Url":"Example URL","OwnerID":0,"GUID":"0","Shared":false,"CreationDate":"2014-11-19T13:23:24.165Z","BusinessID":0,"RegionID":0
}
Deleting a Link
 Request
 DELETE /api/odata/Links(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a Link
 Request
 GET /api/odata/Links(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"ActiveState":1,"Name":"New Link","Description":
"Example Description","Url":"Example URL","OwnerID":0,"GUID":"0","Shared":false,"CreationDate":"2014-11-19T13:23:24.165Z","BusinessID":0,"RegionID":0
}
Updating a Link
 Request
 PUT /api/odata/Links(1)
 Content-Type 
 application/json
 Request body
 {
"ID":"0","ActiveState":"1","Name":"New Link","Description":
"Example Description","Url":"Example URL","OwnerID":"0","GUID":"0","Shared":false,"CreationDate":"2014-11-19T11:23:24.165Z","BusinessID":"0","RegionID":"0"
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all Links
 Request
 GET /api/odata/Links
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"ActiveState":1,"Name":"New Link","Description":
"Example Description","Url":"Example URL","OwnerID":0,"GUID":"0","Shared":false,"CreationDate":"2014-11-19T11:23:24.165Z","BusinessID":0,"RegionID":0
},{
"ID":1,"ActiveState":1,"Name":"New Link","Description":"Example Description","Url":"Example URL","OwnerID":0,"GUID":"0","Shared":false,"CreationDate":"2014-11-19T13:23:24.165Z","BusinessID":0,"RegionID":0
}]