Synupv1
Créer une clé
v1Ressources/Locations

Locations

Créez, consultez, mettez à jour et gérez le cycle de vie d'archivage des établissements appartenant à vos clients.

Renvoie une page d'établissements, les plus récents en premier. Tous les filtres sont facultatifs et se combinent (un établissement doit correspondre à tous) ; pour parcourir plus de résultats, renvoyez le nextCursor reçu.

Lister / rechercher des établissements

get/api/v1/locations
locations:read
Paramètres de requête
clientIdstringfacultatif
Restreint les résultats à un client. Si votre clé est limitée à des clients spécifiques, celui-ci doit en faire partie. Retrouvez-le avec GET /api/v1/clients.
searchstringfacultatif
Recherche libre sur le nom, l'adresse postale, la ville ou le téléphone de l'établissement (insensible à la casse, correspondances partielles autorisées).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)facultatif
Une seule catégorie de statut : all, active (non archivé), archived, archival_pending, verification_pending (approbation Google en attente), unapproved ou requires_action. La valeur par défaut est all.
tagsarray of stringfacultatif
Étiquettes internes — correspond à un établissement possédant au moins une d'entre elles.
categoriesarray of stringfacultatif
Noms d'affichage de catégories — correspond à un établissement dont la catégorie générale ou Google est l'une d'elles.
verificationarray of string (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown.
createdAfterstringfacultatif
Uniquement les établissements créés à cette date ou après.
createdBeforestringfacultatif
Uniquement les établissements créés à cette date ou avant.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente. Laisser vide pour la première page.
limitintegerfacultatif
Nombre d'établissements à renvoyer par page, 1–200. La valeur par défaut est 50.
Réponse
dataobjectfacultatif
locationsarray of objectfacultatif
Les établissements correspondants pour cette page.
idstringfacultatif
Identifiant unique de l'établissement.
namestringfacultatif
Le nom commercial de l'établissement.
addressstringfacultatif
L'adresse postale de l'établissement (lignes de rue combinées), ou null.
citystringfacultatif
Ville.
statestringfacultatif
État ou région.
postalCodestringfacultatif
Code postal, ou null.
countrystringfacultatif
Pays, au format code ISO-3166-1 alpha-2, ou null.
phonestringfacultatif
Numéro de téléphone principal, ou null.
websitestringfacultatif
L'URL du site web de l'établissement, ou null.
storeCodestringfacultatif
Votre code de magasin / référence interne pour cet établissement, ou null.
categorystringfacultatif
La catégorie d'affichage de l'établissement (catégorie principale par publisher si définie, sinon la catégorie générale), ou null.
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement.
labelsarray of stringfacultatif
Libellés internes pour cet établissement.
statusstring (active | archived | archival_pending | verification_pending | unapproved | requires_action)facultatif
Statut dérivé : active, archived, archival_pending, verification_pending (approbation Google en attente), unapproved ou requires_action.
verificationStatusstring (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown, ou null.
pendingChangesnumberfacultatif
Nombre de modifications enregistrées mises en file d'attente pour publication mais pas encore synchronisées avec les annuaires connectés.
lastPublishedAtstringfacultatif
Date de la dernière synchronisation réussie des informations de cet établissement vers un publisher, au format horodatage ISO 8601, ou null.
clientIdstringfacultatif
ID du client auquel appartient cet établissement, ou null.
clientNamestringfacultatif
Nom commercial du client auquel appartient cet établissement, ou null.
createdAtstringfacultatif
Date de création de l'établissement, au format horodatage ISO 8601.
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null lorsqu'il n'y a plus de résultats.
totalnumberfacultatif
Nombre total d'établissements correspondant aux filtres, sur toutes les pages.
Erreurs
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations
Votre clé API
clientId
search
status
tags
categories
verification
createdAfter
createdBefore
cursor
limit
{
  "data": [
    {
      "id": "loc_456",
      "name": "Acme Dental — Downtown",
      "city": "Austin",
      "state": "TX",
      "clientId": "cli_123",
      "createdAt": "2026-01-15T10:05:00.000Z"
    }
  ]
}
v1Ressources/Locations/postCréer un établissement

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

Créer un établissement

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.
streetstringobligatoire
Adresse postale.
street1stringfacultatif
Adresse postale, ligne 2.
citystringobligatoire
Ville.
stateIsostringobligatoire
Code de l'état ou de la région.
postalCodestringobligatoire
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
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"
  }
}
v1Ressources/Locations/getObtenir un établissement

Renvoie le profil complet d'un établissement : adresse, horaires, catégories, attributs, services, médias et statut de vérification.

Obtenir un établissement

get/api/v1/locations/{id}
locations:read
Paramètres de requête
idstringobligatoire
L'établissement à consulter.
Réponse
dataobjectfacultatif
Le profil complet d'un établissement : adresse, horaires, catégories, attributs, services, médias et statut — tout ce que update_location peut modifier, plus ce que create a renvoyé.
idstringfacultatif
Identifiant unique de l'établissement.
namestringfacultatif
Le nom commercial de l'établissement.
descriptionstringfacultatif
Une description de l'entreprise, ou null.
taglinestringfacultatif
Un court slogan pour l'entreprise, ou null.
storeCodestringfacultatif
Votre code de magasin / référence interne pour cet établissement, ou null.
logoUrlstringfacultatif
URL de l'image du logo de l'établissement, ou null.
streetstringfacultatif
Adresse postale, ligne 1, ou null.
street1stringfacultatif
Adresse postale, ligne 2, ou null.
citystringfacultatif
Ville.
statestringfacultatif
État ou région.
postalCodestringfacultatif
Code postal, ou null.
countrystringfacultatif
Pays, au format code ISO-3166-1 alpha-2, ou null.
latitudenumberfacultatif
Latitude, ou null.
longitudenumberfacultatif
Longitude, ou null.
phonestringfacultatif
Numéro de téléphone principal, ou null.
additionalPhonesarray of stringfacultatif
Tout numéro de téléphone supplémentaire en plus du principal.
websitestringfacultatif
L'URL du site web de l'établissement, ou null.
businessEmailstringfacultatif
Une adresse e-mail de contact publique pour l'entreprise, ou null.
categoryNamestringfacultatif
Le nom d'affichage de la catégorie générale, ou null.
primaryCategoryDisplaystringfacultatif
Le nom d'affichage de la catégorie principale effective — par publisher (Google) si définie, sinon générale — ou null.
primaryCategoryGooglestringfacultatif
L'id de catégorie Google principale de l'établissement (gcid), ou null.
additionalCategoriesarray of objectfacultatif
Jusqu'à 9 catégories supplémentaires, chacune avec un id (lorsqu'il est résolu) et un nom d'affichage.
idstringfacultatif
namestringfacultatif
attributesarray of objectfacultatif
Attributs du profil d'établissement Google, sous forme de liste stockée { id, value }.
idstringfacultatif
valueobjectfacultatif
La valeur de l'attribut — un booléen pour les attributs oui/non, une chaîne pour les attributs à choix unique, ou un objet avec setValues/unsetValues pour les choix multiples.
servicesarray of objectfacultatif
Les services ou produits proposés par cet établissement.
namestringfacultatif
descriptionstringfacultatif
pricenumberfacultatif
currencystringfacultatif
googleServiceTypeIdstringfacultatif
ownerNamestringfacultatif
Le nom du propriétaire, ou null.
menuUrlstringfacultatif
URL du menu de l'entreprise, ou null.
yearEstablishednumberfacultatif
L'année de création de l'entreprise, ou null.
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement.
labelsarray of stringfacultatif
Libellés internes pour cet établissement.
regularHoursarray of objectfacultatif
Les horaires réguliers hebdomadaires, ou null.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)facultatif
closedbooleanfacultatif
periodsarray of objectfacultatif
openstringfacultatif
closestringfacultatif
moreHoursarray of objectfacultatif
Types d'horaires supplémentaires au-delà des horaires réguliers (livraison, à emporter, etc.), ou null.
specialHoursarray of objectfacultatif
Des exceptions ponctuelles par date — fermetures pour jours fériés ou horaires spéciaux d'un seul jour — ou null.
mediaByCategoryobjectfacultatif
Éléments multimédias regroupés par catégorie (par ex. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Chaque élément possède une url et, éventuellement, un label, un kind (PHOTO ou VIDEO), une source, un indicateur starred et un assetKey.
clientIdstringfacultatif
ID du client auquel appartient cet établissement, ou null.
archivedbooleanfacultatif
Si l'établissement est archivé.
scheduledArchiveAtstringfacultatif
Date à laquelle l'archivage a été demandé (également le jeton sur lequel cancel-archive se base), au format horodatage ISO 8601, ou null si aucun n'est en attente.
verificationStatusstring (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown, ou null.
Erreurs
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/{id}
Votre clé API
id *
{
  "data": {
    "id": "loc_456",
    "name": "Acme Dental — Downtown",
    "description": null,
    "tagline": null,
    "storeCode": null,
    "logoUrl": null,
    "street": "123 Main St",
    "street1": null,
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "latitude": 30.2672,
    "longitude": -97.7431,
    "phone": "+15125551234",
    "additionalPhones": [],
    "website": "https://acmedental.com",
    "businessEmail": null,
    "categoryName": "Dentist",
    "primaryCategoryDisplay": "Dentist",
    "primaryCategoryGoogle": "gcid:dentist",
    "additionalCategories": [],
    "attributes": [
      {
        "id": "attributes/wi_fi",
        "value": true
      }
    ],
    "services": [
      {
        "name": "Teeth Whitening",
        "description": null,
        "price": 150,
        "currency": "USD",
        "googleServiceTypeId": null
      }
    ],
    "ownerName": null,
    "menuUrl": null,
    "yearEstablished": null,
    "tags": [
      "vip"
    ],
    "labels": [],
    "regularHours": [
      {
        "day": "MONDAY",
        "closed": false,
        "periods": [
          {
            "openTime": "09:00",
            "closeTime": "17:00"
          }
        ]
      }
    ],
    "moreHours": [],
    "specialHours": [],
    "mediaByCategory": {
      "EXTERIOR": [
        {
          "url": "https://cdn.synup.com/media/1.jpg"
        }
      ]
    },
    "clientId": "cli_123",
    "archived": false,
    "scheduledArchiveAt": null,
    "verificationStatus": "verified"
  }
}
v1Ressources/Locations/patchMettre à jour un établissement

Modifie les informations commerciales d'un établissement existant — adresse, catégories, attributs du profil d'établissement Google, services et horaires. Envoyez uniquement les champs que vous souhaitez changer ; un champ envoyé remplace entièrement sa valeur actuelle (une chaîne vide efface un champ texte, une nouvelle liste complète remplace la liste existante). Le pays ne peut pas être modifié après la création. Les modifications enregistrées sont automatiquement mises en file d'attente pour se synchroniser vers les annuaires et fiches connectés.

Mettre à jour un établissement

patch/api/v1/locations/{id}
locations:write
Paramètres de requête
idstringobligatoire
L'établissement à mettre à jour.
Corps de la requête
namestringfacultatif
Le nom commercial de l'établissement.
descriptionstringfacultatif
Une courte description de l'entreprise.
taglinestringfacultatif
Un court slogan pour l'entreprise.
storeCodestringfacultatif
Votre code de magasin / référence interne pour cet établissement.
logoUrlstringfacultatif
URL de l'image du logo de l'établissement.
languageCodestringfacultatif
La langue principale de la fiche, sous forme de code (par ex. « en »).
streetstringfacultatif
Adresse postale.
street1stringfacultatif
Adresse postale, ligne 2.
citystringfacultatif
Ville.
stateIsostringfacultatif
État ou région, au format code ISO (par ex. « CA »).
postalCodestringfacultatif
Code postal.
latitudenumberfacultatif
Latitude. Si vous modifiez l'adresse sans définir également ce champ, elle est redérivée automatiquement.
longitudenumberfacultatif
Longitude. Si vous modifiez l'adresse sans définir également ce champ, elle est redérivée automatiquement.
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.
businessEmailstringfacultatif
Une adresse e-mail de contact publique pour l'entreprise.
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égorie PRINCIPALE par publisher — seul google est actuellement pris en charge ici (un id et un name sont tous deux obligatoires ; n'en transmettre qu'un seul effacerait la catégorie). Facebook/Apple/Bing ne peuvent être modifiés que dans l'éditeur d'établissement. Recherchez la paire id/name de google avec GET /api/v1/locations/publisher-categories.
googleobjectfacultatif
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
attributesobjectfacultatif
Attributs du profil d'établissement Google, sous forme de correspondance entre id d'attribut et valeur (par ex. { "attributes/wi_fi": "free" }) — REMPLACE l'ensemble complet, donc lisez les valeurs actuelles via GET /api/v1/locations/{id} et renvoyez tout ce que vous souhaitez conserver. Un id sans représentation Google valide pour la catégorie de cet établissement est écarté et signalé dans rejectedAttributes plutôt que de faire échouer toute la requête. Il n'existe aucun endpoint listant les ids d'attributs valides pour une catégorie — il s'agit de la référence des attributs Business Profile propre à Google, pas de celle de Synup.
servicesarray of objectfacultatif
Les services ou produits proposés par cet établissement — remplace la liste existante.
namestringfacultatif
descriptionstringfacultatif
pricenumberfacultatif
currencystringfacultatif
googleServiceTypeIdstringfacultatif
ownerNamestringfacultatif
Le nom du propriétaire.
menuUrlstringfacultatif
URL du menu de l'entreprise.
yearEstablishednumberfacultatif
L'année de création de l'entreprise (par ex. 2012).
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement. Remplace la liste existante.
labelsarray of stringfacultatif
Libellés internes pour cet établissement. Remplace la liste existante.
regularHoursarray of objectfacultatif
Les horaires réguliers hebdomadaires — remplace entièrement l'horaire existant. Une entrée par jour de la semaine.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)facultatif
closedbooleanfacultatif
periodsarray of objectfacultatif
openstringfacultatif
closestringfacultatif
moreHoursarray of objectfacultatif
Types d'horaires supplémentaires au-delà des horaires réguliers (livraison, à emporter, happy hour, etc.), remplace la liste existante.
specialHoursarray of objectfacultatif
Des exceptions ponctuelles par date — fermetures pour jours fériés ou horaires spéciaux d'un seul jour — remplace la liste existante. N'importe quelle date du calendrier fonctionne, pas seulement les jours fériés nommés.
applyToPublishersarray of string (google | facebook | apple | bing)facultatif
Change ces valeurs pour des publishers spécifiques uniquement, au lieu de la valeur partagée par défaut dont hérite chaque publisher.
Réponse
dataobjectfacultatif
locationobjectfacultatif
Le profil complet d'un établissement : adresse, horaires, catégories, attributs, services, médias et statut — tout ce que update_location peut modifier, plus ce que create a renvoyé.
idstringfacultatif
Identifiant unique de l'établissement.
namestringfacultatif
Le nom commercial de l'établissement.
descriptionstringfacultatif
Une description de l'entreprise, ou null.
taglinestringfacultatif
Un court slogan pour l'entreprise, ou null.
storeCodestringfacultatif
Votre code de magasin / référence interne pour cet établissement, ou null.
logoUrlstringfacultatif
URL de l'image du logo de l'établissement, ou null.
streetstringfacultatif
Adresse postale, ligne 1, ou null.
street1stringfacultatif
Adresse postale, ligne 2, ou null.
citystringfacultatif
Ville.
statestringfacultatif
État ou région.
postalCodestringfacultatif
Code postal, ou null.
countrystringfacultatif
Pays, au format code ISO-3166-1 alpha-2, ou null.
latitudenumberfacultatif
Latitude, ou null.
longitudenumberfacultatif
Longitude, ou null.
phonestringfacultatif
Numéro de téléphone principal, ou null.
additionalPhonesarray of stringfacultatif
Tout numéro de téléphone supplémentaire en plus du principal.
websitestringfacultatif
L'URL du site web de l'établissement, ou null.
businessEmailstringfacultatif
Une adresse e-mail de contact publique pour l'entreprise, ou null.
categoryNamestringfacultatif
Le nom d'affichage de la catégorie générale, ou null.
primaryCategoryDisplaystringfacultatif
Le nom d'affichage de la catégorie principale effective — par publisher (Google) si définie, sinon générale — ou null.
primaryCategoryGooglestringfacultatif
L'id de catégorie Google principale de l'établissement (gcid), ou null.
additionalCategoriesarray of objectfacultatif
Jusqu'à 9 catégories supplémentaires, chacune avec un id (lorsqu'il est résolu) et un nom d'affichage.
idstringfacultatif
namestringfacultatif
attributesarray of objectfacultatif
Attributs du profil d'établissement Google, sous forme de liste stockée { id, value }.
idstringfacultatif
valueobjectfacultatif
La valeur de l'attribut — un booléen pour les attributs oui/non, une chaîne pour les attributs à choix unique, ou un objet avec setValues/unsetValues pour les choix multiples.
servicesarray of objectfacultatif
Les services ou produits proposés par cet établissement.
namestringfacultatif
descriptionstringfacultatif
pricenumberfacultatif
currencystringfacultatif
googleServiceTypeIdstringfacultatif
ownerNamestringfacultatif
Le nom du propriétaire, ou null.
menuUrlstringfacultatif
URL du menu de l'entreprise, ou null.
yearEstablishednumberfacultatif
L'année de création de l'entreprise, ou null.
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement.
labelsarray of stringfacultatif
Libellés internes pour cet établissement.
regularHoursarray of objectfacultatif
Les horaires réguliers hebdomadaires, ou null.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)facultatif
closedbooleanfacultatif
periodsarray of objectfacultatif
moreHoursarray of objectfacultatif
Types d'horaires supplémentaires au-delà des horaires réguliers (livraison, à emporter, etc.), ou null.
specialHoursarray of objectfacultatif
Des exceptions ponctuelles par date — fermetures pour jours fériés ou horaires spéciaux d'un seul jour — ou null.
mediaByCategoryobjectfacultatif
Éléments multimédias regroupés par catégorie (par ex. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Chaque élément possède une url et, éventuellement, un label, un kind (PHOTO ou VIDEO), une source, un indicateur starred et un assetKey.
clientIdstringfacultatif
ID du client auquel appartient cet établissement, ou null.
archivedbooleanfacultatif
Si l'établissement est archivé.
scheduledArchiveAtstringfacultatif
Date à laquelle l'archivage a été demandé (également le jeton sur lequel cancel-archive se base), au format horodatage ISO 8601, ou null si aucun n'est en attente.
verificationStatusstring (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown, ou null.
rejectedAttributesarray of stringfacultatif
Les ids d'attributs de la requête qui n'ont PAS été écrits — soit ils disposent de leur propre champ dédié, soit leur valeur n'avait aucune représentation Google valide. Présent uniquement lorsqu'au moins un a été rejeté.
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.
patch/api/v1/locations/{id}
Votre clé API
id *
Corps de la requête
{
  "data": {
    "location": {
      "id": "loc_456",
      "name": "Acme Dental — Downtown",
      "tagline": "Gentle care, on time",
      "city": "Austin",
      "state": "TX",
      "clientId": "cli_123"
    },
    "rejectedAttributes": []
  }
}
v1Ressources/Locations/getLister les services d'un emplacement

Les services du Profil d'établissement Google proposés par cet emplacement.

Lister les services d'un emplacement

get/api/v1/locations/{id}/services
locations:read
Paramètres de requête
idstringobligatoire
Réponse
dataobjectfacultatif
servicesarray of objectfacultatif
namestringobligatoire
Nom du service.
descriptionstringfacultatif
Description du service.
pricenumberfacultatif
Prix du service.
currencystringfacultatif
Code de devise du prix.
googleServiceTypeIdstringfacultatif
ID de type de service structuré de Google, si associé.
Erreurs
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/{id}/services
Votre clé API
id *
{
  "data": {
    "services": [
      {
        "name": "Teeth Whitening",
        "description": null,
        "price": 150,
        "currency": "USD",
        "googleServiceTypeId": null
      }
    ]
  }
}
v1Ressources/Locations/postAjouter un service

Ajoute un service à la liste de l'emplacement et republie la liste complète sur Google (Google n'a pas d'ajout atomique — chaque enregistrement remplace tout le tableau).

Ajouter un service

post/api/v1/locations/{id}/services
locations:write
Paramètres de requête
idstringobligatoire
Corps de la requête
namestringobligatoire
Nom du service.
descriptionstringfacultatif
Description du service.
pricenumberfacultatif
Prix du service.
currencystringfacultatif
Code de devise du prix.
googleServiceTypeIdstringfacultatif
ID de type de service structuré de Google, si associé.
Réponse
dataobjectfacultatif
servicesarray of objectfacultatif
namestringobligatoire
Nom du service.
descriptionstringfacultatif
Description du service.
pricenumberfacultatif
Prix du service.
currencystringfacultatif
Code de devise du prix.
googleServiceTypeIdstringfacultatif
ID de type de service structuré de Google, si associé.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/locations/{id}/services
Votre clé API
id *
Corps de la requête*
{
  "data": {
    "services": [
      {
        "name": "Teeth Whitening",
        "description": null,
        "price": 150,
        "currency": "USD",
        "googleServiceTypeId": null
      }
    ]
  }
}
v1Ressources/Locations/deleteSupprimer un service

Supprime un service par son nom et republie la liste restante sur Google.

Supprimer un service

delete/api/v1/locations/{id}/services
locations:write
Paramètres de requête
idstringobligatoire
namestringobligatoire
Nom exact du service à supprimer.
Réponse
dataobjectfacultatif
servicesarray of objectfacultatif
namestringobligatoire
Nom du service.
descriptionstringfacultatif
Description du service.
pricenumberfacultatif
Prix du service.
currencystringfacultatif
Code de devise du prix.
googleServiceTypeIdstringfacultatif
ID de type de service structuré de Google, si associé.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
delete/api/v1/locations/{id}/services
Votre clé API
id *
name *
{
  "data": {
    "services": []
  }
}
v1Ressources/Locations/postPlanifier l'archivage d'un établissement

PLANIFIE l'archivage d'un établissement à la fin de la période de facturation en cours. L'établissement reste pleinement actif, facturable, et continue de compter dans la limite d'établissements du plan jusque-là — rien n'est supprimé, et la planification ne libère pas de place pour ajouter un autre établissement avant que l'archivage n'ait réellement lieu. Appelez cancel-archive pour annuler cela avant qu'il ne se produise, ou reactivate ensuite pour restaurer l'établissement.

Planifier l'archivage d'un établissement

post/api/v1/locations/{id}/archive
locations:write
Paramètres de requête
idstringobligatoire
L'établissement à planifier pour archivage.
Réponse
dataobjectfacultatif
scheduledbooleanfacultatif
Toujours true en cas de succès.
scheduledArchiveAtstringfacultatif
Date à laquelle l'archivage a été demandé (également le jeton sur lequel cancel-archive se base), au format horodatage ISO 8601, ou null si aucun n'est en attente.
archiveAtstringfacultatif
Date à laquelle l'archivage planifié aura réellement lieu — la limite de facturation de l'agence. Null si l'agence n'en a aucune.
Erreurs
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.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/locations/{id}/archive
Votre clé API
id *
{
  "data": {
    "scheduled": true,
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z"
  }
}
v1Ressources/Locations/postAnnuler un archivage planifié

Annule un archivage d'établissement en attente, afin qu'un établissement planifié pour archivage à la fin de la période de facturation continue normalement. Ne fonctionne que tant que l'archivage est encore en attente — un établissement déjà archivé doit plutôt être réactivé.

Annuler un archivage planifié

post/api/v1/locations/{id}/cancel-archive
locations:write
Paramètres de requête
idstringobligatoire
L'établissement dont l'archivage en attente doit être annulé.
Réponse
dataobjectfacultatif
cancelledbooleanfacultatif
Toujours true en cas de succès.
Erreurs
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.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/locations/{id}/cancel-archive
Votre clé API
id *
{
  "data": {
    "cancelled": true
  }
}
v1Ressources/Locations/postRéactiver un établissement archivé

Restaure un établissement déjà archivé — ainsi que chacune de ses fiches — et efface toute planification d'archivage en attente. Un établissement qui n'est pas actuellement archivé se traduit par un succès sans effet, pas par une erreur.

Réactiver un établissement archivé

post/api/v1/locations/{id}/reactivate
locations:write
Paramètres de requête
idstringobligatoire
L'établissement à réactiver.
Réponse
dataobjectfacultatif
archivedbooleanfacultatif
Si l'établissement est archivé.
cancelledScheduledPostsnumberfacultatif
Nombre de publications planifiées annulées dans le cadre d'une réactivation depuis un état archivé, le cas échéant.
Erreurs
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/locations/{id}/reactivate
Votre clé API
id *
{
  "data": {
    "archived": false,
    "cancelledScheduledPosts": 0
  }
}
v1Ressources/Locations/getObtenir le résumé des emplacements

Renvoie le nombre agrégé d'emplacements de toute votre agence (ou d'un client), ventilé par statut, niveau de forfait et statut de vérification.

Obtenir le résumé des emplacements

get/api/v1/locations/summary
locations:read
Paramètres de requête
clientIdstringfacultatif
Limite aux emplacements d'un client. Omis, cela résume tous les emplacements que votre clé peut voir. Retrouvez-le avec GET /api/v1/clients.
tagsstringfacultatif
Limite aux emplacements portant l'une de ces étiquettes internes séparées par des virgules.
Réponse
dataobjectfacultatif
totalnumberfacultatif
Nombre total d'emplacements correspondants.
byStatusobjectfacultatif
Nombre d'emplacements regroupé par statut.
byVerificationobjectfacultatif
Nombre d'emplacements regroupé par statut de vérification.
Erreurs
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/summary
Votre clé API
clientId
tags
{
  "data": {
    "total": 12,
    "byStatus": {
      "approved": 10,
      "pending_verification": 1,
      "archival_pending": 1
    },
    "byVerification": {
      "verified": 9,
      "pending": 1,
      "unknown": 2
    }
  }
}
v1Ressources/Locations/postCréer une étiquette

Crée une nouvelle étiquette interne, associée à un client.

Créer une étiquette

post/api/v1/locations/tags
locations:write
Corps de la requête
clientIdstringobligatoire
Le client auquel appartient cette étiquette. Retrouvez-le avec GET /api/v1/clients.
namestringobligatoire
Le nom de l'étiquette.
Réponse
dataobjectfacultatif
idstringfacultatif
Identifiant unique de l'étiquette nouvellement créée.
namestringfacultatif
Le nom de l'étiquette.
clientIdstringfacultatif
Le client auquel appartient cette étiquette. Retrouvez-le avec GET /api/v1/clients.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/locations/tags
Votre clé API
Corps de la requête*
{
  "data": {
    "id": "tag_789",
    "name": "VIP",
    "clientId": "cli_123"
  }
}
v1Ressources/Locations/deleteSupprimer une étiquette

Supprime une étiquette interne. Cela ne supprime pas les emplacements auxquels elle était appliquée. locationsUnassigned dans la réponse indique combien d'établissements ont perdu cette étiquette.

Supprimer une étiquette

delete/api/v1/locations/tags/{id}
locations:write
Paramètres de requête
idstringobligatoire
ID de l'étiquette à supprimer.
Réponse
dataobjectfacultatif
locationsUnassignednumberfacultatif
Nombre d'établissements ayant cette étiquette — tous ont perdu l'association lors de la suppression de l'étiquette.
Erreurs
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
delete/api/v1/locations/tags/{id}
Votre clé API
id *
{
  "data": {
    "locationsUnassigned": 3
  }
}
v1Ressources/Locations/postAjouter des emplacements à une étiquette

Applique une étiquette existante à un ou plusieurs emplacements.

Ajouter des emplacements à une étiquette

post/api/v1/locations/tags/{id}/locations
locations:write
Paramètres de requête
idstringobligatoire
ID de l'étiquette.
Corps de la requête
locationIdsarray of stringobligatoire
IDs des emplacements à étiqueter.
Réponse
dataobjectfacultatif
addedarray of stringfacultatif
IDs des emplacements auxquels l'étiquette a réellement été ajoutée.
skippedarray of stringfacultatif
IDs des emplacements ignorés car ils portaient déjà cette étiquette.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/locations/tags/{id}/locations
Votre clé API
id *
Corps de la requête*
{
  "data": {
    "added": [
      "loc_456"
    ],
    "skipped": []
  }
}
v1Ressources/Locations/deleteRetirer un emplacement d'une étiquette

Dissocie un seul emplacement, par son id, d'une étiquette.

Retirer un emplacement d'une étiquette

delete/api/v1/locations/tags/{id}/locations
locations:write
Paramètres de requête
idstringobligatoire
ID de l'étiquette.
locationIdstringobligatoire
ID de l'emplacement à désétiqueter.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
delete/api/v1/locations/tags/{id}/locations
Votre clé API
id *
locationId *
{}
v1Ressources/Locations/getRechercher dans la taxonomie de catégories générales

Recherche dans la taxonomie générale des catégories d'entreprise (reflète celle de Google, des milliers d'entrées) — données de référence globales, non limitées à votre agence. L'id renvoyé est un id de Category à définir comme categoryId d'un emplacement à la création ou la mise à jour. Pour le catalogue propre d'un publisher spécifique, utilisez plutôt GET /api/v1/locations/publisher-categories. Omettez complètement search pour lister toute la taxonomie, sans limite.

Rechercher dans la taxonomie de catégories générales

get/api/v1/locations/categories
locations:read
Paramètres de requête
searchstringfacultatif
Sous-chaîne du nom de catégorie à faire correspondre. Omettre pour lister toute la taxonomie, sans limite (limit est alors ignoré).
limitintegerfacultatif
Nombre de lignes à renvoyer, 1–100. La valeur par défaut est 25.
Réponse
dataobjectfacultatif
categoriesarray of objectfacultatif
Les catégories générales correspondantes.
idstringfacultatif
L'id de catégorie — transmettez-le en tant que categoryId lors de la création ou de la mise à jour.
namestringfacultatif
Le nom d'affichage de la catégorie.
Erreurs
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/categories
Votre clé API
search
limit
{
  "data": {
    "categories": [
      {
        "id": "cat_dentist",
        "name": "Dentist"
      },
      {
        "id": "cat_orthodontist",
        "name": "Orthodontist"
      }
    ]
  }
}
v1Ressources/Locations/getRechercher dans le catalogue de catégories propre à un publisher

Recherche dans le catalogue propre (GABF) d'un publisher — données de référence globales, non limitées à votre agence. Utilisez l'id renvoyé pour les publisherCategories d'un emplacement à la création ou la mise à jour. Omettez complètement query pour lister tout le catalogue du publisher, sans limite.

Rechercher dans le catalogue de catégories propre à un publisher

get/api/v1/locations/publisher-categories
locations:read
Paramètres de requête
publisherstring (google | facebook | apple | bing)obligatoire
Le catalogue de quel publisher rechercher : google, apple, bing ou facebook.
querystringfacultatif
Sous-chaîne du nom de catégorie à faire correspondre. Omettre pour lister tout le catalogue du publisher, sans limite.
countrystringfacultatif
Pays au format ISO-3166-1 alpha-2 — recommandé pour apple, dont les catégories sont spécifiques à chaque pays.
Réponse
dataobjectfacultatif
categoriesarray of objectfacultatif
Les catégories correspondantes dans le catalogue propre au publisher demandé.
idstringfacultatif
L'id de catégorie propre au publisher — transmettez-le dans publisherCategories lors de la création ou de la mise à jour. Null est possible pour une entrée de catalogue sans id.
displayNamestringfacultatif
Le nom d'affichage de la catégorie dans le catalogue de ce publisher.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/publisher-categories
Votre clé API
publisher *
query
country
{
  "data": {
    "categories": [
      {
        "id": "gcid:dentist",
        "displayName": "Dentist"
      }
    ]
  }
}
v1Ressources/Locations/getLister les établissements avec leurs médias

Liste les établissements avec leurs photos, les plus récents en premier — mêmes filtres que GET /api/v1/locations. Utilisez ceci pour des questions comme « quels établissements n'ont pas de photos ? », plutôt que GET /api/v1/media, qui ne renvoie les médias que d'UN seul établissement à la fois.

Lister les établissements avec leurs médias

get/api/v1/locations/media
media:read
Paramètres de requête
clientIdstringfacultatif
Limite aux établissements d'un seul client. Obligatoire lorsque votre clé est limitée à des clients spécifiques — il n'y a ici aucun champ client par ligne permettant de vérifier un résultat fusionné et non limité, donc un clientId omis est refusé plutôt que deviné. Retrouvez-le avec GET /api/v1/clients.
searchstringfacultatif
Recherche libre sur le nom, l'adresse postale, la ville ou le téléphone de l'établissement (insensible à la casse, correspondances partielles autorisées).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)facultatif
Une seule catégorie de statut : all, active (non archivé), archived, archival_pending, verification_pending (approbation Google en attente), unapproved ou requires_action. La valeur par défaut est all.
tagsarray of stringfacultatif
Étiquettes internes — correspond à un établissement possédant au moins une d'entre elles.
categoriesarray of stringfacultatif
Noms d'affichage de catégories — correspond à un établissement dont la catégorie générale ou Google est l'une d'elles.
verificationarray of string (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown.
createdAfterstringfacultatif
Uniquement les établissements créés à cette date ou après.
createdBeforestringfacultatif
Uniquement les établissements créés à cette date ou avant.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente. Laisser vide pour la première page.
limitintegerfacultatif
Nombre d'établissements à renvoyer par page, 1–100. La valeur par défaut est 100.
Réponse
dataobjectfacultatif
locationsarray of objectfacultatif
Les établissements correspondants pour cette page.
idstringfacultatif
Identifiant unique de l'établissement.
namestringfacultatif
Le nom commercial de l'établissement.
logoUrlstringfacultatif
URL du logo de l'établissement, ou null.
mediaByCategoryobjectfacultatif
Éléments multimédias regroupés par catégorie (par ex. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Chaque élément possède une url et, éventuellement, un label, un kind (PHOTO ou VIDEO), une source, un indicateur starred et un assetKey.
totalnumberfacultatif
Nombre total de photos dans toutes les catégories pour cet établissement.
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null lorsqu'il n'y a plus de résultats.
totalnumberfacultatif
Nombre total d'établissements correspondant aux filtres, sur toutes les pages.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/media
Votre clé API
clientId
search
status
tags
categories
verification
createdAfter
createdBefore
cursor
limit
{
  "data": {
    "locations": [
      {
        "id": "loc_456",
        "name": "Acme Dental — Downtown",
        "logoUrl": null,
        "mediaByCategory": {
          "EXTERIOR": [
            {
              "url": "https://cdn.synup.com/media/1.jpg"
            }
          ]
        },
        "total": 1
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}
v1Ressources/Locations/postTéléverser des photos vers un établissement

Ajoute une ou plusieurs photos à un établissement, dans une catégorie donnée. Fournissez chaque image sous forme d'URL https publique (récupérée et réhébergée) ou d'octets encodés en base64. Seules les images sont prises en charge (jpeg, png, gif, webp), 5 Mo maximum chacune. La catégorie LOGO ne contient qu'un seul logo — téléverser vers LOGO remplace celui en cours. Toute autre catégorie s'ajoute à l'existant. Les photos enregistrées sont automatiquement mises en file d'attente pour être publiées sur Google.

Téléverser des photos vers un établissement

post/api/v1/locations/{id}/media
locations:write
Paramètres de requête
idstringobligatoire
L'établissement auquel ajouter des photos.
Corps de la requête
categorystring (COVER | PROFILE | LOGO | EXTERIOR | INTERIOR | PRODUCT | FOOD_AND_DRINK | MENU | AT_WORK | TEAMS | ROOMS | COMMON_AREA | ADDITIONAL)obligatoire
La catégorie de photo à laquelle ajouter. LOGO remplace le logo actuel ; toute autre catégorie s'ajoute à l'existant.
imagesarray of objectobligatoire
Une ou plusieurs images à ajouter. Chacune nécessite un url ou un base64.
urlstringfacultatif
Une URL https publique vers l'image — elle est récupérée et réhébergée.
base64stringfacultatif
Les octets de l'image en base64 (un préfixe d'URL data: est accepté). Utilisez ceci à la place de url lorsque vous disposez des octets.
labelstringfacultatif
Légende/libellé optionnel pour la photo.
Réponse
dataobjectfacultatif
mediaByCategoryobjectfacultatif
Éléments multimédias regroupés par catégorie (par ex. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Chaque élément possède une url et, éventuellement, un label, un kind (PHOTO ou VIDEO), une source, un indicateur starred et un assetKey.
addedarray of objectfacultatif
La ou les photos réellement ajoutées, chacune avec la catégorie dans laquelle elle a été placée et son URL hébergée.
categorystringfacultatif
urlstringfacultatif
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/{id}/media
Votre clé API
id *
Corps de la requête*
{
  "data": {
    "mediaByCategory": {
      "EXTERIOR": [
        {
          "url": "https://cdn.synup.com/media/1.jpg",
          "source": "agent_upload"
        }
      ]
    },
    "added": [
      {
        "category": "EXTERIOR",
        "url": "https://cdn.synup.com/media/1.jpg"
      }
    ]
  }
}
v1Ressources/Locations/deleteSupprimer les photos d'un établissement

Retire des photos d'un établissement. Transmettez urls pour supprimer des photos spécifiques, ou category pour vider une catégorie entière. Le logo ne peut jamais être supprimé via cet endpoint — ni par url ni par category — téléversez plutôt une nouvelle image LOGO pour le remplacer. Cela retire les photos dans l'application ; cela ne les supprime pas de Google.

Supprimer les photos d'un établissement

delete/api/v1/locations/{id}/media
locations:write
Paramètres de requête
idstringobligatoire
L'établissement duquel retirer des photos.
Corps de la requête
urlsarray of stringfacultatif
URLs de photos spécifiques à retirer (depuis le mediaByCategory d'un établissement).
categorystring (COVER | PROFILE | EXTERIOR | INTERIOR | PRODUCT | FOOD_AND_DRINK | MENU | AT_WORK | TEAMS | ROOMS | COMMON_AREA | ADDITIONAL)facultatif
Vide toutes les photos de cette catégorie. LOGO n'est pas une valeur autorisée — le logo ne peut pas être supprimé.
Réponse
dataobjectfacultatif
mediaByCategoryobjectfacultatif
Éléments multimédias regroupés par catégorie (par ex. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Chaque élément possède une url et, éventuellement, un label, un kind (PHOTO ou VIDEO), une source, un indicateur starred et un assetKey.
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.
delete/api/v1/locations/{id}/media
Votre clé API
id *
Corps de la requête
{
  "data": {
    "mediaByCategory": {
      "EXTERIOR": []
    },
    "removed": [
      "https://cdn.synup.com/media/1.jpg"
    ]
  }
}