Criar campo personalizado

POST 
/contacts/fields

Um campo novo para os contatos. key e type não mudam depois. Os tipos select e multi_select exigem options; os outros não aceitam.

Uma API key restrita a alguns números recebe 403: esta operação é da base inteira.

Request

Responses

201

Contato criado.

401

Token ausente, malformado, desconhecido ou revogado (authentication), ou conta suspensa (tenant_inactive).

402

Sem direito de uso (payment_required). O corpo traz o motivo em reason e a saída em action: o que fazer (kind) e a página do painel onde se faz (url).

403

O recurso informado não pertence à sua conta (forbidden), ou o caminho está na lista de bloqueio do espelho (forbidden_endpoint), ou a sua API key é restrita a alguns números e a operação é da conta inteira (forbidden).

409

contact_field_exists (a chave já existe) ou contact_field_limit_reached (o plano chegou ao teto de campos, contando os arquivados).

422

Payload reprovado na validação (invalid_request, com o detalhamento em issues) ou recusado pela Meta (meta_error, com o corpo original em meta).

429

Limite de requisições excedido (rate_limit).

Response Headers

Retry-After

Segundos a aguardar antes de tentar de novo.

X-RateLimit-Category

Categoria do limite aplicada — send, media ou default.

X-RateLimit-Scope

Qual balde os outros headers descrevem — key (a API key), session (o painel) ou account (o teto da conta).

X-RateLimit-Limit

Teto de requisições da categoria na janela atual.

X-RateLimit-Remaining

Requisições restantes na janela atual.