v1Recursos/Custom Fields/putEstablecer un valor de campo personalizado
Establecer un valor de campo personalizado
Establece un valor de campo personalizado en una ubicación o cliente. Indique null (o un valor vacío) para vaciar el campo. El valor se valida frente a la definición del campo — por ejemplo, el valor de un campo de selección debe ser una de sus opciones definidas.
put
custom-fields:write/api/v1/custom-fields/valuesCuerpo de la solicitud
entityTypestring (location | client)obligatorio
El tipo de entidad al que se aplica este campo: "location" o "client".
entityIdstringobligatorio
ID de la ubicación o cliente en el que establecer el valor.
keystringobligatorio
Clave de la definición de campo personalizado a establecer, tal como se devuelve en su propiedad key.
valueobjectobligatorio
El valor a almacenar. Debe estar presente en el cuerpo de la solicitud, pero puede ser null o vacío para vaciar el campo. Se valida frente al tipo y las opciones del campo.
Respuesta
dataobjectopcional
valuesobjectopcional
Los valores de campos personalizados de la entidad, organizados por la clave del campo. Un valor es una cadena, un número, un array de cadenas (para multi_select), o está ausente cuando no se ha establecido.
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.
put/api/v1/custom-fields/values
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"values": {
"parking_notes": "Free lot behind the building."
}
}
}