API / CustomField

Entity Description:

Custom Field allows a user to further customize the custom fields in the PoliteMail Personalization feature (e.g. salutation, birthdate, department, etc…).  Custom Field may also be used for Personalization merge fields within the New PoliteMail Message editor.

 

Properties

Name Description Type Additional
Information
ID Int32
Name String
Show Boolean

 

Entity Statement

Creating a CustomField
Request
POST /ssv3/odata/CustomFields
Content-Type     
application/json
Request body
{
“ID”:”0″,”Name”:”New Field”,”Show”:true
}
Response body
{
“ID”:1,”Name”:”New Field”,”Show”:true
}
Deleting a CustomField
  Request
  DELETE /ssv3/odata/CustomFields(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a List
  Request
  GET /ssv3/odata/CustomFields(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”Name”:”New Field”,”Show”:true
}
Updating a CustomField
  Request
  PUT /ssv3/odata/CustomFields(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”Name”:”New Field”,”Show”:true
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Lists
  Request
  GET /ssv3/odata/CustomFields
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”Name”:”New Field”,”Show”:true
},{
“ID”:1,”Name”:”New Field”,”Show”:true
}]