Synupv1
Criar chave
v1Recursos/Custom Fields/postCriar uma definição de campo personalizado

Criar uma definição de campo personalizado

Adiciona um novo campo personalizado ao esquema para o tipo de entidade informado. A key do campo é derivada do seu label e é imutável depois disso; campos do tipo select exigem pelo menos uma opção.

post/api/v1/custom-fields/definitions
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".
labelstringobrigatório
O rótulo de exibição do campo personalizado.
typestring (text | number | date | single_select | multi_select)obrigatório
O tipo de valor do campo: text, number, date, single_select ou multi_select.
requiredbooleanopcional
Se o campo deve ser marcado como required. Opcional; o padrão é false.
optionsarray of stringopcional
As opções selecionáveis do campo. Obrigatório (pelo menos uma) para campos single_select e multi_select; ignorado para outros tipos.
Resposta
dataobjectopcional
definitionobjectopcional
idstringopcional
Identificador único da definição de campo personalizado.
entityTypestring (location | client)opcional
O tipo de entidade ao qual esta definição se aplica: "location" ou "client".
keystringopcional
Slug imutável identificando este campo, derivado do seu label na criação. Use isto para referenciar o campo ao definir valores.
labelstringopcional
O rótulo de exibição do campo personalizado.
typestring (text | number | date | single_select | multi_select)opcional
O tipo de valor do campo.
requiredbooleanopcional
Se o campo está marcado como required. Isto não é aplicado pela API — é apenas uma dica para a interface.
optionsarray of stringopcional
As opções selecionáveis do campo, para campos single_select e multi_select. Null para outros tipos.
createdBystringopcional
Quem criou esta definição de campo: "user" ou "agent".
ordernumberopcional
A ordem de exibição do campo em relação a outras definições do mesmo tipo de entidade, a menor primeiro.
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.
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.
post/api/v1/custom-fields/definitions
Sua chave de API
Corpo da solicitação*
{
  "data": {
    "definition": {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": false,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  }
}