Synup
Créer une clé
v1Ressources/Locations/deleteRetirer des établissements d'un groupe

Retirer des établissements d'un groupe

Retire des établissements du groupe. Sur chaque annuaire qui publie le groupe, l'établissement est supprimé de l'entreprise du groupe et sa fiche (ainsi que sur les sites régionaux qui la reprennent) est effacée, il est donc renvoyé séparément. S'il partage un numéro de téléphone avec d'autres établissements, cet annuaire peut le refuser à nouveau. Un établissement qu'un annuaire n'a pas pu retirer est renvoyé dans `directoryFailures` et reste dans le groupe.

delete/api/v1/location-groups/{groupId}/locations
locations:write
Paramètres de requête
groupIdstringobligatoire
L'id du groupe d'établissements.
Corps de la requête
locationIdsarray of stringobligatoire
Ids ou ids publics d'établissements.
Réponse
dataobjectfacultatif
removedintegerfacultatif
Établissements retirés du groupe.
directoryLocationsDeletedintegerfacultatif
Établissements supprimés de l'entreprise du groupe sur les annuaires.
directoryFailuresarray of objectfacultatif
Établissements qu'un annuaire n'a pas pu retirer ; ils restent dans le groupe.
locationIdstringfacultatif
sitestringfacultatif
reasonstringfacultatif
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/location-groups/{groupId}/locations
Votre clé API
groupId *
Corps de la requête*
{}

Guides qui utilisent cette ressource