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

Actualizar una definición de campo personalizado

Edita la etiqueta, el indicador de obligatorio, las opciones o el orden de visualización de una definición de campo personalizado. El tipo y la clave del campo no se pueden cambiar después de crearlo.

patch/api/v1/custom-fields/definitions
custom-fields:write
Cuerpo de la solicitud
definitionIdstringobligatorio
ID de la definición de campo personalizado a actualizar.
labelstringopcional
La etiqueta visible del campo personalizado.
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.
ordernumberopcional
Nuevo orden de visualización de esta definición respecto a otras del mismo tipo de entidad.
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.
404El recurso no se encontró, o no pertenece a su agencia.
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.
patch/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": true,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  }
}