Synup
Créer une clé
v1Ressources/Locations/postCréer un établissement

Créer un établissement

Crée un nouvel établissement pour un client existant et le soumet pour publication.

post/api/v1/locations
locations:write
Corps de la requête
clientIdstringobligatoire
ID du client sous lequel créer cet établissement. Retrouvez-le avec GET /api/v1/clients.
namestringobligatoire
Le nom commercial de l'établissement.
countryIsostringobligatoire
Code pays ISO, par ex. US.
streetstringfacultatif
Adresse postale.
street1stringfacultatif
Adresse postale, ligne 2.
citystringfacultatif
Ville.
stateIsostringfacultatif
Code de l'état ou de la région.
postalCodestringfacultatif
Code postal.
phonestringfacultatif
Numéro de téléphone.
additionalPhonesarray of stringfacultatif
Tout numéro de téléphone supplémentaire en plus du principal.
websitestringfacultatif
URL du site web.
categoryIdstringfacultatif
Id de catégorie générale — à rechercher avec GET /api/v1/locations/categories.
categoryNamestringfacultatif
Nom d'affichage de la catégorie générale.
publisherCategoriesobjectfacultatif
Catégories par publisher, une par publisher, chacune un { id, name } consulté via GET /api/v1/locations/publisher-categories.
googleobjectfacultatif
idstringfacultatif
namestringfacultatif
facebookobjectfacultatif
idstringfacultatif
namestringfacultatif
appleobjectfacultatif
idstringfacultatif
namestringfacultatif
bingobjectfacultatif
idstringfacultatif
namestringfacultatif
additionalCategoriesarray of objectfacultatif
Jusqu'à 9 catégories supplémentaires, chacune un { id?, name }. Un simple name est accepté et son id est résolu à partir du catalogue de catégories lorsqu'une correspondance existe. Recherchez les identifiants vous-même avec GET /api/v1/locations/categories.
idstringfacultatif
namestringfacultatif
descriptionstringfacultatif
Une courte description de l'entreprise.
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement.
latitudenumberfacultatif
Latitude, en degrés décimaux. Dérivée automatiquement de l'adresse si omise.
longitudenumberfacultatif
Longitude, en degrés décimaux. Dérivée automatiquement de l'adresse si omise.
customFieldsobjectfacultatif
Valeurs de champs personnalisés à définir sur cet établissement, indexées par id de champ.
Réponse
dataobjectfacultatif
locationIdstringfacultatif
ID de l'établissement nouvellement créé.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/locations
Votre clé API
Corps de la requête*
{
  "data": {
    "locationId": "loc_456"
  }
}

Guides qui utilisent cet endpoint