Documentation Index Fetch the complete documentation index at: https://developers.matchsales.com.br/llms.txt Use this file to discover all available pages before exploring further.
Adiciona, oculta ou configura a obrigatoriedade de um campo no funil e retorna o resultado. Todas as propriedades são opcionais; omitir preserva o valor atual. As listas de etapas substituem as regras somente deste funil. As regras de outros funis permanecem iguais. Todo identificador de etapa deve pertencer a este funil, ou a API responde 400.
isVisible: true inclui o campo no funil; false o oculta. Campos personalizados existentes começam ocultos em um novo funil. Um novo campo também começa oculto nos funis existentes.
requiredStageIds define a obrigatoriedade validada pelo servidor. Criar ou mover um negócio para uma dessas etapas, ou uma etapa posterior, exige o preenchimento. Caso contrário, responde 422 UNPROCESSABLE_ENTITY, com os campos ausentes em fieldErrors, tanto pelo aplicativo quanto pela API. Uma regra na etapa de perda vale somente nela. Movimentações por automação são isentas.
isRequired marca o campo como obrigatório no funil para os formulários do aplicativo. Sozinho, não impõe uma validação no servidor: use requiredStageIds para exigir o preenchimento também por API. isRequired: true e uma lista requiredStageIds não vazia são incompatíveis e resultam em 400. Alterar isRequired sem enviar a lista limpa as etapas obrigatórias.
visibilityOverrideStageIds define as etapas que invertem isVisible. Alterar isVisible sem enviar essa lista limpa as exceções.
isSuggested e suggestedStageIds representam o nível sugerido. O aplicativo solicita o preenchimento ao mover o negócio para a etapa, mas permite pular. O servidor não o exige e a sugestão não se propaga às etapas posteriores. Obrigatório implica sugerido e visível: ativar isRequired também ativa isSuggested e isVisible. Uma etapa nas duas listas permanece apenas em requiredStageIds. Desativar isRequired sem enviar isSuggested desativa também a sugestão. Ocultar um campo que permanece sugerido ou obrigatório resulta em 400; envie também isSuggested: false e isRequired: false. isSuggested: true e uma lista suggestedStageIds não vazia também são incompatíveis. Alterar isSuggested sem enviar a lista limpa as etapas sugeridas.
Campos padrão aceitam somente requiredStageIds e suggestedStageIds; outras propriedades resultam em 400. Exige settings.pipelines.
Exemplos
A URL usa o servidor de produção. Defina PIPEFACIL_API_KEY e as variáveis de caminho (como SEQ ou ID) com os identificadores reais. Ajuste o corpo antes de executar: requisições de escrita alteram dados do workspace.
Identificador de campo personalizado de negócio (GET /api/v1/custom-fields?entity=deal) ou uma chave padrão: value, name, email, phone, expectedCloseAt.
Somente campos personalizados. Não impõe exigência no servidor; consulte requiredStageIds. Incompatível com uma lista requiredStageIds não vazia; alterar limpa a lista, a menos que ela seja enviada.
requiredStageIds
array
Não
Substitui as etapas deste funil que exigem o campo. [] limpa a lista.
visibilityOverrideStageIds
array
Não
Somente campos personalizados. Substitui as etapas que invertem isVisible neste funil.
isSuggested
boolean
Não
Somente campos personalizados. Sem exigência no servidor. Incompatível com uma lista suggestedStageIds não vazia. Alterar limpa a lista, salvo quando enviada. É verdadeiro enquanto isRequired for verdadeiro; desligar isRequired desliga a sugestão, a menos que isSuggested seja enviado.
suggestedStageIds
array
Não
Substitui as etapas deste funil que sugerem o preenchimento. [] limpa a lista. Etapas também presentes em requiredStageIds permanecem apenas como obrigatórias.
Esquema OpenAPI
{ "type": "object", "description": "Todas as propriedades são opcionais; omitir preserva o valor atual.", "properties": { "isVisible": { "type": "boolean", "description": "Somente campos personalizados." }, "isRequired": { "type": "boolean", "description": "Somente campos personalizados. Não impõe exigência no servidor; consulte `requiredStageIds`. Incompatível com uma lista `requiredStageIds` não vazia; alterar limpa a lista, a menos que ela seja enviada." }, "requiredStageIds": { "type": "array", "maxItems": 200, "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": "Substitui as etapas deste funil que exigem o campo. `[]` limpa a lista." }, "visibilityOverrideStageIds": { "type": "array", "maxItems": 200, "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": "Somente campos personalizados. Substitui as etapas que invertem `isVisible` neste funil." }, "isSuggested": { "type": "boolean", "description": "Somente campos personalizados. Sem exigência no servidor. Incompatível com uma lista suggestedStageIds não vazia. Alterar limpa a lista, salvo quando enviada. É verdadeiro enquanto isRequired for verdadeiro; desligar isRequired desliga a sugestão, a menos que isSuggested seja enviado." }, "suggestedStageIds": { "type": "array", "maxItems": 200, "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": "Substitui as etapas deste funil que sugerem o preenchimento. `[]` limpa a lista. Etapas também presentes em requiredStageIds permanecem apenas como obrigatórias." } }, "example": { "isVisible": true, "requiredStageIds": [ "stage-id-of-proposal" ] }}
Respostas
200Sucesso
Campo
Tipo
Descrição
data
PipelineFieldSettings
Configuração de um campo de negócio neste funil. Os identificadores seguem a ordem das etapas do funil.
data.field
string
ID do campo personalizado ou chave do campo padrão.
data.kind
string
Valores: standard, custom.
data.name
string
—
data.slug
string
Chave do valor em customFields do negócio; null para campo padrão. Aceita null.
data.isVisible
boolean
Indica se o campo aparece no funil. null para campo padrão. Aceita null.
data.isRequired
boolean
Sinaliza obrigatoriedade nos formulários do aplicativo, sem validação do servidor por si só. null para campo padrão. Aceita null.
data.requiredStageIds
array
Etapas a partir das quais o campo é obrigatório no servidor. Lista vazia quando não há exigência.
data.visibilityOverrideStageIds
array
Etapas que invertem isVisible. null para campo padrão. Aceita null.
data.isSuggested
boolean
Sinaliza sugestão nos formulários do aplicativo em toda movimentação, com opção de pular. Sem exigência no servidor. Sempre true quando isRequired é verdadeiro. null para campo padrão. Aceita null.
data.suggestedStageIds
array
Etapas onde o aplicativo sugere o preenchimento, com opção de pular e sem propagação. Não repete etapas de requiredStageIds. Lista vazia quando não há sugestão.
403Autenticado, mas sem acesso: falta de permissão (`FORBIDDEN`), recurso desligado no workspace (`FEATURE_DISABLED`) ou tentativa de acessar uma agenda não permitida.
