v1Recursos/AEO/postAtualizar campos de prompts AEO
Atualizar campos de prompts AEO
Cria, renomeia ou arquiva um campo personalizado dos prompts AEO monitorados de um site, ou define valores em seus prompts ativos ou pausados. Envie locationId, um mutationId e um command. Os campos são apenas anotações: não mudam o que as verificações de prompts medem nem o que consomem. Enquanto o gerenciamento de prompts estiver desativado para a agência, os campos continuam legíveis, mas não podem ser alterados.
post
aeo:write/api/v1/aeo/prompts/fieldsCorpo da solicitação
locationIdstringobrigatório
ID do local cujo conjunto de campos você está alterando. Para prompts AEO, o site.
mutationIdstringobrigatório
Um UUID que você escolhe para esta alteração. Reenviá-lo com o mesmo command retorna o primeiro resultado sem aplicar a alteração de novo; reutilizá-lo com um command diferente retorna 409.
commandobjectobrigatório
Uma alteração. field_create adiciona um campo com label, type e options. field_update renomeia um campo, altera suas opções ou o arquiva ou restaura, e exige a versão atual do campo como expectedVersion. values_update define de 1 a 1000 valores, cada um com recordId, fieldId, value e expectedVersion, e aplica todos ou nenhum. Uma opção que registros ainda usam não pode ser removida; arquive-a em vez disso. Um conjunto de campos comporta no máximo 40 campos, incluindo os arquivados.
Resposta
dataobjectopcional
resultobjectopcional
O que a alteração fez: o id do campo para field_create e field_update, ou o número de valores gravados para values_update.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
413O corpo da requisição é maior que 1 MB.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Siga as orientações de nova tentativa para esta operação.
post/api/v1/aeo/prompts/fields
Sua chave de API
Corpo da solicitação*
{}Guias que usam este recurso
- What Is a Local SEO API?A local SEO API measures how a business ranks in local search, with geo-grid rank tracking, profile analytics and AI visibility, not just backlinks.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- What Is an AEO API?An AEO API measures how AI answer engines like ChatGPT, Gemini and Perplexity describe and recommend a business, and tracks that visibility over time.
- How to Build an AI Agent for Local SEOBuild an AI agent that audits and fixes listings, tracks local rankings, checks AI visibility and drafts review replies with Synup's MCP server or REST tools.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- Local SEO APIs: What Developers Actually NeedA practical checklist of what a local SEO API must cover, from listings and sync status to reviews, rank tracking and AI visibility, mapped to endpoints.
- How to Monitor Local SEO Across Multiple LocationsMonitor local SEO across hundreds of locations through rollup endpoints, with rank and AI visibility per location and the weakest surfaced first.
- How to Track AI and AEO Visibility ProgrammaticallyMeasure how ChatGPT, Gemini and Perplexity describe and recommend a business through an API, enqueue reports, poll for results and roll up a portfolio.