ContactField resource

Methods

  • post - Create a contact field
  • get - Get contact field detail

Resource

{
    "custom": "boolean",
    "defaultCountryCode": "string",
    "defaultValue": "string",
    "id": "string",
    "maxDate": "string",
    "maxLength": "number",
    "maxValue": "number",
    "minDate": "string",
    "minValue": "number",
    "name": "string",
    "options": [
        {
            "id": "string",
            "label": "string"
        }
    ],
    "readOnly": "boolean",
    "required": "boolean",
    "status": "string",
    "type": "string"
}

Properties

Name Type Description Additional
custom boolean

Indicates if the field is custom. Custom fields are created by the member of the store.
defaultCountryCode string

Indicates if the default country code of the phone field. Only available when the field type is "phone".

 Optional
defaultValue string

The default value of the field. Default value must be set always when the field is required.

 Optional
id string

The identifier of the field
maxDate string

Indicates if the max valid date of a date field. Only available when the field type is "date".

 Optional
maxLength number

Indicates if the max length of the text field. Only available when the field type is "text".

 Optional
maxValue number

Indicates if the max valid value of a field. Only available when the field type is "integer" or "decimal".

 Optional
minDate string

Indicates if the min valid date of a date field. Only available when the field type is "date".

 Optional
minValue number

Indicates if the min valid value of a field. Only available when the field type is "integer" or "decimal".

 Optional
name string

The name of the field
options[] array

Indicates the allowed options of a field. Only available when the field type is "checkbox" or "radio".

 Optional
options[].id string

The identifier of the option
options[].label string

The label of the option
readOnly boolean

Indicates if the field is read only. If true the field value cannot be modified.
required boolean

Indicates if the field is required. When a field is required it means that a contact must have always a value for that field. A required field must always have a default value set.
status string

The processing status of the field

Possible values are:

  • ready
  • queued-for-deletion
  • queued-for-initialization
  • initializing
  • deleting
type string

The type of the field

Possible values are:

  • text
  • integer
  • decimal
  • boolean
  • date
  • radio
  • checkbox
  • phone
  • email