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
if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.
| Creating a CustomField | |
| Request | |
| POST /api/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 /api/odata/CustomFields(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a List | |
| Request | |
| GET /api/odata/CustomFields(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"Name":"New Field","Show":true } | |
| Updating a CustomField | |
| Request | |
| PUT /api/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 /api/odata/CustomFields | |
| Content-Type | |
| application/json | |
| Response body | |
| "value":[{ "ID":0,"Name":"New Field","Show":true },{ "ID":1,"Name":"New Field","Show":true }] | |
