v1CustomFields

Retrieve a custom field

Changed on
get/v1/custom-fields/{id}

Request

  • Base URL: https://api4.kinbox.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api4.kinbox.com.br/v1/custom-fields/{id}
  • Auth: none declared

Path parameters

idnumber required

Response

idstring required
namestring required

Nome do campo

descriptionstring

Descrição para te ajudar a saber para que serve esse campo

entity'contact' | 'group' | 'channel' | 'session' | 'user' | 'product' | 'task' | 'deal' | 'organization'

Descrição para te ajudar a saber para que serve esse campo

placeholderstring

Chave que identifica esse campo em vários lugares. Geralmente é o nome em lowercase

type'text' | 'textarea' | 'number' | 'decimal' | 'select' | 'multi-select' | 'boolean' | 'date' | 'day' | 'datetime' | 'json' required

O tipo de campo que será mostrado e parseado

isActiveboolean required
isDeletedboolean required
invisibleboolean required

Se ativo não mostra no plugin de contato em uma conversa

positionnumber required
isUniqueIdentifierboolean required
isIntegrationboolean required

Se é um campo usado para uma integração

showAlwaysboolean required
requiredToResolveboolean required

Caso ativo somente permite resolver conversa se esse campo estiver ativado

resetOnNewCallboolean required

Caso ativo quando for uma nova sessão esse campo será resetado.

Example response

{
  "name": "CPF",
  "description": "Serve para identificar o contato",
  "placeholder": "cpf",
  "options": [
    {
      "value": "pt-BR",
      "label": "Português"
    }
  ]
}

Changes

  • c083bbfe8973Revision changes
    • warning

      added the new organization enum value to the response property for the response status