v1Recursos/Custom Fields/putDefinir um valor de campo personalizado

Definir um valor de campo personalizado

Define um valor de campo personalizado em um local ou cliente. Passe null (ou um valor vazio) para limpar o campo. O valor é validado contra a definição do campo — por exemplo, o valor de um campo select deve ser uma de suas opções definidas.

put/api/v1/custom-fields/values

custom-fields:write

Corpo da solicitação

entityTypestring (location | client)obrigatório

O tipo de entidade ao qual este campo se aplica: "location" ou "client".

entityIdstringobrigatório

ID do local ou cliente no qual definir o valor.

keystringobrigatório

Key da definição de campo personalizado a ser definida, conforme retornada em sua propriedade key.

valueobjectobrigatório

O valor a ser armazenado. Deve estar presente no corpo da solicitação, mas pode ser null ou vazio para limpar o campo. Validado contra o type e as options do campo.

Resposta

dataobjectopcional

valuesobjectopcional

Os valores de campos personalizados da entidade, indexados pela key do campo. Um valor é uma string, um número, um array de strings (para multi_select), ou ausente quando não definido.

Erros

400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

put/api/v1/custom-fields/values

Sua chave de API

Corpo da solicitação*

{
  "data": {
    "values": {
      "parking_notes": "Free lot behind the building."
    }
  }
}