Synup
Criar chave
v1Recursos/Locations/postCriar um local

Criar um local

Cria um novo local para um cliente existente e o envia para publicação.

post/api/v1/locations
locations:write
Corpo da solicitação
clientIdstringobrigatório
ID do cliente sob o qual este local será criado. Procure com GET /api/v1/clients.
namestringobrigatório
O nome comercial do local.
countryIsostringobrigatório
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 — consulte com GET /api/v1/locations/categories.
categoryNamestringopcional
Nome de exibição da categoria geral.
publisherCategoriesobjectopcional
Categorias por publisher, uma para cada publisher, cada uma um { id, name } obtido via GET /api/v1/locations/publisher-categories.
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.
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