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.
Atualiza parcialmente a definição de um campo e retorna o resultado. Exige settings.custom_fields.
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.
const response = await fetch(`https://pipefacil-server.matchsales.com.br/api/v1/custom-fields/${process.env.ID}`, { method: "PATCH", headers: { Authorization: `Bearer ${process.env.PIPEFACIL_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "placeholder": "Informe o segmento da empresa"}),});if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);const text = await response.text();const data = text ? JSON.parse(text) : null;
Python
import osimport jsonimport requestsresponse = requests.request( "PATCH", f"https://pipefacil-server.matchsales.com.br/api/v1/custom-fields/{os.environ['ID']}", headers={"Authorization": f"Bearer {os.environ['PIPEFACIL_API_KEY']}"}, json=json.loads("{\n \"placeholder\": \"Informe o segmento da empresa\"\n}"),)response.raise_for_status()data = response.json() if response.content else None
Parâmetros
Nome
Local
Tipo
Obrigatório
Descrição
id
path
string
Sim
Identificador do campo personalizado.
Corpo da requisição
Content-Type: application/json · obrigatório
{ "placeholder": "Informe o segmento da empresa"}
Campo
Tipo
Obrigatório no objeto
Descrição
name
string
Não
Aceita null. Até 255 caracteres.
description
string
Não
Aceita null. Até 1000 caracteres.
placeholder
string
Não
Omitir ou enviar nulo preserva o valor atual; texto em branco limpa o campo. Aceita null. Até 255 caracteres.
options
array
Não
Aceita null.
config
object
Não
Configuração por tipo de campo. Para event, informe event com título, duração e configuração da reunião. member_field usa fieldSlug para ler um membro a partir de um campo members do lead. Aceita null.
Slug do campo members cujo usuário será convidado. Lido novamente quando o campo mudar. Aceita null.
config.event.attendees[].label
string
Não
Rótulo usado pelo editor; não determina a identidade do convidado. Aceita null. Até 255 caracteres.
isRequired
boolean
Não
Aceita null.
apiOnly
boolean
Não
Define se os valores dos negócios só podem ser alterados por /api/v1. Aceita null.
displayOrder
integer
Não
Aceita null. Mínimo: 0.
section
string
Não
Aceita null. Até 255 caracteres.
visibilityRule
object
Não
Substitui a regra. Omitir ou enviar nulo preserva a regra atual. Aceita null.
visibilityRule.parentFieldId
string
Sim
—
visibilityRule.values
array
Sim
—
clearVisibilityRule
boolean
Não
Quando verdadeiro, remove a regra de visibilidade. Não envie junto com visibilityRule: isso resulta em 422. Aceita null.
Esquema OpenAPI
{ "type": "object", "description": "Todos os campos são opcionais. Tipo, slug e entidade são imutáveis após a criação e não são aceitos nesta atualização.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true }, "description": { "type": "string", "maxLength": 1000, "nullable": true }, "placeholder": { "type": "string", "maxLength": 255, "nullable": true, "description": "Omitir ou enviar nulo preserva o valor atual; texto em branco limpa o campo." }, "options": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true } }, "config": { "type": "object", "additionalProperties": true, "nullable": true, "properties": { "event": { "$ref": "#/components/schemas/EventFieldConfig" } }, "description": "Configuração por tipo de campo. Para event, informe event com título, duração e configuração da reunião. member_field usa fieldSlug para ler um membro a partir de um campo members do lead." }, "isRequired": { "type": "boolean", "nullable": true }, "apiOnly": { "type": "boolean", "nullable": true, "description": "Define se os valores dos negócios só podem ser alterados por /api/v1." }, "displayOrder": { "type": "integer", "minimum": 0, "nullable": true }, "section": { "type": "string", "maxLength": 255, "nullable": true }, "visibilityRule": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldVisibilityRule" } ], "nullable": true, "description": "Substitui a regra. Omitir ou enviar nulo preserva a regra atual." }, "clearVisibilityRule": { "type": "boolean", "nullable": true, "description": "Quando verdadeiro, remove a regra de visibilidade. Não envie junto com visibilityRule: isso resulta em 422." } }, "example": { "placeholder": "Informe o segmento da empresa" }}
Respostas
200Sucesso
Campo
Tipo
Descrição
data
CustomFieldDefinition
—
data.id
string
—
data.entityType
string
—
data.name
string
—
data.slug
string
—
data.description
string
Aceita null.
data.placeholder
string
Texto de exemplo exibido no campo vazio. Aceita null.
data.fieldType
string
—
data.options
array
Opções de seleção. Em select e multi_select, ficam na definição. Em members, são calculadas a partir dos membros do workspace a cada leitura; value é o userId do membro. Aceita null.
data.options[].value
string
—
data.options[].label
string
—
data.options[].color
string
Aceita null.
data.options[].image
string
URL da foto. Somente para members. Aceita null.
data.options[].inactive
boolean
Somente para members. Verdadeiro para membro desativado. Ele permanece na lista para resolver nomes de valores anteriores. Não o ofereça para novas escolhas nem altere valores já salvos por causa dessa marcação.
data.config
object
Configuração por tipo de campo. Para event, informe event com título, duração e configuração da reunião. member_field usa fieldSlug para ler um membro a partir de um campo members do lead. Aceita null.
403Autenticado, mas sem acesso: falta de permissão (`FORBIDDEN`), recurso desligado no workspace (`FEATURE_DISABLED`) ou tentativa de acessar uma agenda não permitida.
409Conflito de estado, como um negócio aberto duplicado para o contato/funil, ou limite do plano atingido (`QUOTA_EXCEEDED`), como na criação de um funil além da cota.
