For AI agents: the complete documentation index is available at https://docs.clickmax.io/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/reference/fields.md.
  • Português
  • Campos

    Referência dos campos aceitos pelos formulários e pela API do CRM ao criar ou editar um contato, uma oportunidade ou um campo personalizado. Cada tabela lista o nome do campo, o tipo, a restrição e se é obrigatório.

    Papel exigido: criar ou editar contatos e criar oportunidades exige o papel Proprietário, Administrador, Editor ou Atendente no workspace — os papéis Visualizador, Financeiro e Convidado não executam essas escritas. Ao criar oportunidade, o Atendente ainda precisa estar vinculado ao pipeline de destino. Criar campos personalizados exige apenas ser membro autenticado do workspace. Veja o alcance de cada papel em Permissões.

    Contato — criar

    Campos aceitos ao cadastrar um contato manualmente.

    CampoTipoRestriçãoObrigatório
    nametexto—Sim
    emaile-mail5–255 caracteres, formato e-mailNão
    telephonetextomáx. 20, apenas dígitos com + opcional (^\+?\d+$)Não
    instagramtexto—Não
    tagIdslista de tagsIDs (UUID) de tags existentesNão
    customFieldValueslistavalores de campos personalizadosNão

    Contato — editar

    Campos aceitos ao atualizar um contato. Todos são opcionais; enviar null limpa o campo.

    CampoTipoRestriçãoObrigatório
    nametexto—Não
    emaile-mail5–255 caracteres, formato e-mailNão
    telephonetextomáx. 20, ^\+?\d+$Não
    addressobjetoendereçoNão
    citytexto—Não
    statetexto—Não
    professiontexto—Não
    languagetexto—Não
    genderIdentityenummale, female, otherNão
    documenttexto—Não
    birthdaydatadata (AAAA-MM-DD)Não
    isSmsbooleano—Não
    instagramtexto—Não
    telegramUsernametexto—Não
    linkedintexto—Não
    twitterXtexto—Não
    tiktoktexto—Não
    youtubetexto—Não
    whatsappNumbertexto—Não
    originenumorigem do contato — ver tabela abaixoNão
    observationstexto—Não

    Origem do contato (origin)

    A origem registra por onde o contato entrou na base. Ela é gravada no primeiro toque e aparece na coluna Origem do contato da lista de contatos, no perfil do contato e no card Canais de entrada. Os mesmos valores estão disponíveis como condição Origem em filtros, segmentos, condicionais de automação e condicionais de funil.

    ValorComo aparece na interface
    CxAffiliatesClickmax Affiliates
    CxCalendarCX Calendar
    CxClientsClickmax Clients
    CxCloneClickmax Clone
    CxClubClickmax Club
    CxDomainsClickmax Domains
    CxExternalPagesPágina Externa
    CxFlowsClickmax Flows
    CxFormsClickmax Forms
    CxFunnelsClickmax Funnels
    CxInsightsClickmax Insights
    CxLinkProtectClickmax Link Protect
    CxPagesClickmax Pages
    CxPayClickmax Pay
    CxProductsClickmax Products
    CxQuizzesClickmax Quizzes
    CxSendClickmax Send
    CxSplitClickmax Split
    CxStoreClickmax Store
    CxTagsClickmax Tags
    CxTemplatesClickmax Templates
    CxTrackingClickmax Tracking
    CxWalletClickmax Wallet
    CxWebchatClickmax Webchat
    CxWebinarClickmax Webinar
    CxWhatsappContactsAgenda do WhatsApp
    IntegrationsIntegrações
    Clickfunnels, Framer, HotmartPages, Kirvano, Mailchimp, Webflow, Wix, Wordpressnome da ferramenta externa que capturou o contato

    Suborigem do contato (subOrigin)

    A suborigem detalha a origem quando o mesmo módulo captura de mais de uma forma. Quando o contato tem suborigem, é ela que a coluna Origem do contato exibe, junto do selo da origem. No modo especialista ela tem coluna própria, Sub-origem, e nos filtros e segmentos existe como condição Sub-origem (ou Origem ou sub-origem, que procura nos dois campos de uma vez).

    ValorComo aparece na interface
    CxManualCreationCriação manual
    CxManualImportCsvImportação manual
    CxWebinarRegistrationInscrição no webinário
    CxWebinarMagicLinkLink mágico do webinário
    WhatsappChatStartChat no WhatsApp
    TelegramChatStartChat no Telegram
    WebchatChatStartChat no Webchat
    InstagramDMReceivedMensagem direta no Instagram
    InstagramStoryReplyResposta ao story do Instagram
    InstagramPostCommentComentário na publicação do Instagram
    SmsSendKeywordPalavra-chave via SMS

    Quando a origem é Integrações, a suborigem é o nome da plataforma que enviou o contato: ActiveCampaign, Asaas, Braip, Cartpanda, Eduzz, Greenn, Guru, Hotmart, HotWebinar, Hubla, Kiwify, Kommo, Manychat, Monetizze, Pagarme, PerfectPay, Principia, Stripe, Ticto, TMB, VStage, Vunel, WebinarKit ou Yampi.

    Oportunidade — criar card

    Campos aceitos ao criar uma oportunidade em um pipeline.

    CampoTipoRestriçãoObrigatório
    leadIdslistaIDs (UUID) de contatosSim
    pipelineIdUUIDpipeline de destinoSim
    stageIdUUIDetapa de destinoSim
    titletexto—Não
    valueinteiro≥ 0 (em centavos)Não
    probabilityinteiro0–100Não
    attendantIdslistaIDs (UUID) de atendentesNão
    productIdslistaIDs (UUID) de produtosNão
    offerIdslistaIDs (UUID) de ofertasNão
    companyIdUUIDempresa vinculadaNão
    funnelIdUUIDfunil de origemNão
    priorityenumurgent, high, medium, low, noneNão
    temperatureenumhot, warm, cold, frozenNão
    expectedClosingDatetexto (data)data prevista de fechamentoNão
    origintextoorigem da oportunidade (padrão ManualCreated)Não
    referredBytextoindicado porNão
    isRecurringbooleanooportunidade recorrenteNão
    customFieldValueslistavalores de campos personalizadosNão

    Campo personalizado — configuração

    Campos aceitos ao criar um campo personalizado no CRM.

    CampoTipoRestriçãoObrigatório
    entityTypeenumleads, opportunitiesSim
    fieldNametexto1–100 caracteresSim
    displayNametexto1–200 caracteresSim
    fieldTypeenumver tabela abaixoSim
    descriptiontextomáx. 500 caracteresNão
    requiredbooleano—Não
    uniquebooleano—Não
    defaultValuequalquervalor padrãoNão
    optionslistapares label/value (para seleção)Não
    formulatextoexpressão (tipo formula)Não
    ordernúmeroordem de exibiçãoNão
    groupNametextomáx. 100 caracteresNão
    showInListbooleanoexibir na listaNão
    showInDetailbooleanoexibir no detalheNão
    showInCreatebooleanoexibir na criaçãoNão
    showOnCardbooleanoexibir no cardNão
    pinnedbooleanofixarNão
    filterablebooleanopermitir filtroNão

    Tipos de campo personalizado (fieldType)

    ValorDescrição
    textTexto curto
    textareaTexto longo
    numberNúmero
    currencyValor monetário
    percentagePorcentagem
    dateData
    booleanVerdadeiro/falso
    selectSeleção única
    multi_selectSeleção múltipla
    radioOpção única (rádio)
    ratingAvaliação
    linkLink
    fileArquivo
    imageFoto: link http(s) da imagem enviada; outro formato é recusado
    formulaFórmula
    jsonJSON

    Relacionados

    Se não funcionou

    • Campo ou botão indisponível → seu papel não permite a ação; veja Sem permissão.
    • Valor recusado na validação → confira a restrição na tabela e os Códigos de erro.