Synupv1
Crear clave
v1Recursos/Custom Fields/postCrear una definición de campo personalizado

Crear una definición de campo personalizado

Agrega un nuevo campo personalizado al esquema del tipo de entidad indicado. La clave del campo se deriva de su etiqueta y es inmutable después de creada; los campos de tipo selección requieren al menos una opción.

post/api/v1/custom-fields/definitions
custom-fields:write
Cuerpo de la solicitud
entityTypestring (location | client)obligatorio
El tipo de entidad al que se aplica este campo: "location" o "client".
labelstringobligatorio
La etiqueta visible del campo personalizado.
typestring (text | number | date | single_select | multi_select)obligatorio
El tipo de valor del campo: text, number, date, single_select o multi_select.
requiredbooleanopcional
Si el campo debe marcarse como obligatorio. Opcional; el valor predeterminado es false.
optionsarray of stringopcional
Las opciones seleccionables del campo. Obligatorio (al menos una) para campos single_select y multi_select; se ignora para otros tipos.
Respuesta
dataobjectopcional
definitionobjectopcional
idstringopcional
Identificador único de la definición de campo personalizado.
entityTypestring (location | client)opcional
El tipo de entidad al que se aplica esta definición: "location" o "client".
keystringopcional
Slug inmutable que identifica este campo, derivado de su etiqueta al crearlo. Úselo para referenciar el campo al establecer valores.
labelstringopcional
La etiqueta visible del campo personalizado.
typestring (text | number | date | single_select | multi_select)opcional
El tipo de valor del campo.
requiredbooleanopcional
Si el campo está marcado como obligatorio. Esto no se aplica en la API — es solo una indicación para la interfaz.
optionsarray of stringopcional
Las opciones seleccionables del campo, para campos single_select y multi_select. Null para otros tipos.
createdBystringopcional
Quién creó esta definición de campo: "user" o "agent".
ordernumberopcional
El orden de visualización del campo respecto a otras definiciones del mismo tipo de entidad, del más bajo al más alto.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/custom-fields/definitions
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "definition": {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": false,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  }
}