Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Users

Create a user field

post/users/v1/fields

Request body

data_type'FIELD_VALUE_TYPE_UNSPECIFIED' | 'FIELD_VALUE_TYPE_STRING' | 'FIELD_VALUE_TYPE_MONEY' | 'FIELD_VALUE_TYPE_TIMESTAMP' | 'FIELD_VALUE_TYPE_USER_ID' | 'FIELD_VALUE_TYPE_SELECT' | 'FIELD_VALUE_TYPE_TEMPLATE_ID' | 'FIELD_VALUE_TYPE_MULTI_SELECT' | 'FIELD_VALUE_TYPE_SITE' | 'FIELD_VALUE_TYPE_MULTI_SITE' | 'FIELD_VALUE_TYPE_INTEGER' | 'FIELD_VALUE_TYPE_ADDRESS' | 'FIELD_VALUE_TYPE_TIMEZONE' | 'FIELD_VALUE_TYPE_CONTACT_DETAILS'

Type of FieldValue. Defaults to type String.

  • FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified.
  • FIELD_VALUE_TYPE_STRING: Field value type string.
  • FIELD_VALUE_TYPE_MONEY: Field value type money.
  • FIELD_VALUE_TYPE_TIMESTAMP: Field value type timestamp.
  • FIELD_VALUE_TYPE_USER_ID: Field value type user ID.
  • FIELD_VALUE_TYPE_SELECT: Field value type select
  • FIELD_VALUE_TYPE_TEMPLATE_ID: Field value type template ID.
  • FIELD_VALUE_TYPE_MULTI_SELECT: Field value type multi-select
  • FIELD_VALUE_TYPE_SITE: Field value type site
  • FIELD_VALUE_TYPE_MULTI_SITE: Field value type multi-site
  • FIELD_VALUE_TYPE_INTEGER: Field value type integer
  • FIELD_VALUE_TYPE_ADDRESS: Field value type address.
  • FIELD_VALUE_TYPE_TIMEZONE: Field value type timezone
  • FIELD_VALUE_TYPE_CONTACT_DETAILS: Field value type contact details
namestring

Required. Attribute name

descriptionstring

The attribute description

Response

A successful response.