We're upgrading our API

On June 6th, 2019, Mailbox API 1.0 will be sunsetted, and at that time any apps using this legacy API will no longer work. Please use Mailbox API 2.0 instead.

Field Object

Field Guide

The field object represents a user's response to a custom field in the context of a single conversation.

Name Type Example Notes
fieldId Int 1 The field definition identifier; note that multiple conversations will each have values for the same field identifier
name String Team The name of the field; note that this may change if a field is renamed, but the fieldId will not
value String Development The value the user specified for the field
type String SINGLE_LINE Type of the custom field
label String Development String representation of the custom field's value. Unlike value it contains the actual dropdown option value for DROPDOWN custom field.

Allowed values for specific Custom Fields Types

Field Type Expected format
SINGLE_LINE Text, maximal length is 255 characters
MULTI_LINE Text, maximal length is 65535
DATE Date and in following format : yyyy-MM-dd
NUMBER Any number - integer or with floating point
DROPDOWN ID of associated Custom Field Option

Example - Editing custom field response

It's enough to provide fieldId and value

{
  "fieldId": 1,
  "name": "Team"
}

Example - object returned from the server

{
    "fieldId": 1,
    "name": "Team",
    "value": "Development",
    "type": "SINGLE_LINE",
    "label": "DEVELOPMENT"
}