v1Recursos/Locations/postCriar um local
Criar um local
Cria um local, sob um dos seus clientes (clientId) ou sozinho, e o envia para publicação. Exige name, countryIso e uma categoria: categoryId, categoryName ou publisherCategories.google.
post
locations:write/api/v1/locationsCorpo da solicitação
clientIdstringopcional
ID do cliente sob o qual criar este local. Consulte com GET /api/v1/clients. Opcional, como "Sem cliente" no app: se omitido, o local é criado sozinho. Uma chave limitada a clientes específicos precisa enviá-lo.
kindstring (location | website)opcional
location (the default) is a physical business listing. website is a website entity — a brand's site tracked for reviews, SEO, AEO and social — created from a name and a website alone. It is not a billable location, and it needs website entities enabled for the workspace (403 otherwise).
namestringobrigatório
O nome comercial do local.
countryIsostringopcional
Código de país ISO, ex.: US.
streetstringopcional
Endereço.
street1stringopcional
Endereço, linha 2.
citystringopcional
Cidade.
stateIsostringopcional
Código do estado ou região.
postalCodestringopcional
CEP ou código postal.
phonestringopcional
Número de telefone.
additionalPhonesarray of stringopcional
Quaisquer números de telefone adicionais além do principal.
websitestringopcional
URL do site.
categoryIdstringopcional
Id da categoria geral, de GET /api/v1/locations/categories. Um local precisa de uma categoria: envie isto, categoryName ou publisherCategories.google.
categoryNamestringopcional
Nome de exibição da categoria geral. Um local precisa de uma categoria: envie isto, categoryId ou publisherCategories.google. Um nome que não está no catálogo é mantido como categoria de exibição.
publisherCategoriesobjectopcional
Categorias por publisher, uma por publisher, cada uma um { id, name } consultado em GET /api/v1/locations/publisher-categories. Na criação, publisherCategories.google também atende ao requisito de categoria.
googleobjectopcional
idstringopcional
namestringopcional
facebookobjectopcional
idstringopcional
namestringopcional
appleobjectopcional
idstringopcional
namestringopcional
bingobjectopcional
idstringopcional
namestringopcional
additionalCategoriesarray of objectopcional
Até 9 categorias extras, cada uma um { id?, name }. Um nome isolado é aceito e seu id é resolvido a partir do catálogo de categorias, quando houver correspondência. Procure os ids você mesmo com GET /api/v1/locations/categories.
idstringopcional
namestringopcional
descriptionstringopcional
Uma breve descrição do negócio.
tagsarray of stringopcional
Tags internas para organização própria — não exibidas publicamente.
latitudenumberopcional
Latitude, em graus decimais. Derivada automaticamente do endereço, se omitida.
longitudenumberopcional
Longitude, em graus decimais. Derivada automaticamente do endereço, se omitida.
customFieldsobjectopcional
Valores de campos personalizados a definir neste local, indexados por id de campo.
serviceAreaobjectopcional
Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório
CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.
placesarray of objectopcional
Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.
namestringobrigatório
placeIdstringopcional
ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.
placeTypestring (country | administrativeArea | locality | postalCode)opcional
publisherServiceAreasobjectopcional
Uma área de atendimento diferente para Google, Facebook, Apple ou Bing, cada uma no mesmo formato de serviceArea. Ela é salva como o valor próprio desse publisher e retornada em publisherOverrides. Um publisher omitido usa serviceArea.
googleobjectopcional
Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório
CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.
placesarray of objectopcional
Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.
namestringobrigatório
placeIdstringopcional
ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.
placeTypestring (country | administrativeArea | locality | postalCode)opcional
facebookobjectopcional
Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório
CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.
placesarray of objectopcional
Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.
namestringobrigatório
placeIdstringopcional
ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.
placeTypestring (country | administrativeArea | locality | postalCode)opcional
appleobjectopcional
Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório
CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.
placesarray of objectopcional
Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.
namestringobrigatório
placeIdstringopcional
ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.
placeTypestring (country | administrativeArea | locality | postalCode)opcional
bingobjectopcional
Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório
CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.
placesarray of objectopcional
Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.
namestringobrigatório
placeIdstringopcional
ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.
placeTypestring (country | administrativeArea | locality | postalCode)opcional
socialLinksobjectopcional
URLs de perfis sociais: facebook, instagram, twitter, linkedin, youtube, tiktok, pinterest. Na atualização, só mudam as chaves enviadas; null remove uma. Publicados no Google como seus atributos url_* e no Bing e na Apple.
facebookstringopcional
instagramstringopcional
twitterstringopcional
linkedinstringopcional
youtubestringopcional
tiktokstringopcional
pintereststringopcional
paymentMethodsarray of stringopcional
Formas de pagamento aceitas, por exemplo "Visa", "American Express", "Cash only". Substitui a lista inteira; uma lista vazia ou null a limpa. Publicadas no Google como seus atributos pay_* e na Apple e no Bing.
Resposta
dataobjectopcional
locationIdstringopcional
ID do local recém-criado.
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.
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/locations
Sua chave de API
Corpo da solicitação*
{
"data": {
"locationId": "loc_456"
}
}Guias que usam este endpoint
- What Is a Business Listings API?A business listings API manages a business's name, address, hours and more across many publishers at once, with sync status and duplicate detection built in.
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Create a Location with the Synup APICreate a business location in one POST, with or without a client, get back a locationId, and know which fields matter and which can wait.
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- 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.
- How to Manage Thousands of Business Locations via APIDesign a sync job for thousands of locations on the Synup API with cursor pagination, tags, rate-limit handling, an id map and rollup health checks.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.