Synup
Créer une clé
v1Ressources/Clients/getObtenir un ensemble d’annuaires

Obtenir un ensemble d’annuaires

Les propriétaires et administrateurs ayant accès aux Clients gèrent les ensembles. Les membres disposant d’un accès à toute l’agence peuvent lister les choix et attribuer des ensembles aux clients accessibles. Les identifiants limités à des clients sont refusés. Des siteIds vides excluent tous les annuaires ; les ensembles ne peuvent pas élargir les droits de l’agence. Les modifications exigent la révision actuelle et au moins un champ modifié. Un ensemble attribué ne peut pas être supprimé. L’attribution est atomique et planifie les ajustements des fiches en arrière-plan.

get/api/v1/publisher-sets/{id}
clients:read
Paramètres de requête
idstringobligatoire
ID de l’ensemble.
Réponse
dataobjectfacultatif
publisherSetobjectfacultatif
idstringfacultatif
namestringfacultatif
Nom unique de 100 caractères maximum.
siteIdsarray of integerfacultatif
Sélection complète des IDs d’annuaires. Un tableau vide exclut tous les annuaires.
revisionintegerfacultatif
Révision actuelle renvoyée par une lecture. Les révisions périmées sont refusées.
createdAtstringfacultatif
updatedAtstringfacultatif
clientCountintegerfacultatif
adjustmentstringfacultatif
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.
409Le nom est pris, la révision est périmée ou l’ensemble est encore attribué.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/publisher-sets/{id}
Votre clé API
id *
{}

Guides qui utilisent cette ressource