Synup
Crear clave
v1Recursos/Locations/postCrear una ubicación

Crear una ubicación

Crea una nueva ubicación para un cliente existente y la envía para su publicación.

post/api/v1/locations
locations:write
Cuerpo de la solicitud
clientIdstringobligatorio
ID del cliente bajo el que se creará esta ubicación. Búsquelo con GET /api/v1/clients.
namestringobligatorio
El nombre comercial de la ubicación.
countryIsostringobligatorio
Código de país ISO, p. ej. US.
streetstringopcional
Dirección postal.
street1stringopcional
Dirección postal, línea 2.
citystringopcional
Ciudad.
stateIsostringopcional
Código de estado o región.
postalCodestringopcional
Código postal.
phonestringopcional
Número de teléfono.
additionalPhonesarray of stringopcional
Cualquier número de teléfono adicional además del principal.
websitestringopcional
URL del sitio web.
categoryIdstringopcional
Id de categoría general — búsquelo con GET /api/v1/locations/categories.
categoryNamestringopcional
Nombre visible de la categoría general.
publisherCategoriesobjectopcional
Categorías por publisher, una por publisher, cada una un { id, name } consultado mediante GET /api/v1/locations/publisher-categories.
googleobjectopcional
idstringopcional
namestringopcional
facebookobjectopcional
idstringopcional
namestringopcional
appleobjectopcional
idstringopcional
namestringopcional
bingobjectopcional
idstringopcional
namestringopcional
additionalCategoriesarray of objectopcional
Hasta 9 categorías adicionales, cada una un { id?, name }. Se acepta un name solo, y su id se resuelve a partir del catálogo de categorías cuando hay una coincidencia. Busca los ids tú mismo con GET /api/v1/locations/categories.
idstringopcional
namestringopcional
descriptionstringopcional
Una breve descripción del negocio.
tagsarray of stringopcional
Etiquetas internas para su propia organización — no se muestran públicamente.
latitudenumberopcional
Latitud, en grados decimales. Se deriva automáticamente de la dirección si se omite.
longitudenumberopcional
Longitud, en grados decimales. Se deriva automáticamente de la dirección si se omite.
customFieldsobjectopcional
Valores de campos personalizados a establecer en esta ubicación, indexados por id de campo.
Respuesta
dataobjectopcional
locationIdstringopcional
ID de la ubicación recién creada.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/locations
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "locationId": "loc_456"
  }
}

Guías que usan este endpoint