Legacy Mailbox API 1.0 is deprecated

Legacy Mailbox API 1.0 was deprecated on November 20, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.

Custom Field Object

Custom Field Guide

The custom field object represents optional data that can defined for specific mailbox and filled when creating or updating a Conversation.

Name Type Example Notes
id Int 1 Unique custom field definition identifier
fieldName String Project The name of the field; note that this may change if a field is renamed, but the id will not
fieldType Enumerated String SINGLE_LINE Type of the field - with following values: SINGLE_LINE, MULTI_LINE, DATA, NUMBER or DROPDOWN
required Boolean true Flag for UI to mark the field as required
order Int 10 Relative order of the custom field. Can be null or a number between 0 and 255.
options Collection   Collection of Option objects;

Example

Simple text field

{
  "id": 1,
  "fieldName": "Project",
  "fieldType": "SINGLE_LINE",
  "required": true,
  "order" : 10,
  "options" : null
}

Dropdown field

{
  "id": 2,
  "fieldName": "Card",
  "fieldType": "DROPDOWN",
  "required": true,
  "order" : 10,
  "options" : [
    {
      "id": 1,
      "label": "Ford",
      "order": 1
    },
    {
    "id": 2,
    "label": "GM",
    "order": 2
    }
  ]
}
↑Back to top
© Help Scout 2024