Synup
Créer une clé
v1Ressources/Fiches publiées/postDéfinir l’exclusion d’une fiche

Définir l’exclusion d’une fiche

Nécessite l’accès aux annuaires et à l’établissement. L’exclusion masque cet annuaire pour le client, empêche de nouveaux travaux et annule ceux qui ne sont pas envoyés. L’historique et la fiche publiée restent intacts. La réintégration ne peut pas contourner le groupe d’annuaires du client. Les changements sont attribués à l’utilisateur authentifié dans l’audit.

post/api/v1/listings/opt-out
listings:write
Corps de la requête
locationIdstringobligatoire
Identifiant d’établissement ou identifiant public.
siteIdintegerobligatoire
Identifiant numérique de l’annuaire dans le catalogue.
optedOutbooleanobligatoire
true exclut ce couple établissement-annuaire ; false le rétablit sous réserve des restrictions du groupe d’annuaires.
Réponse
dataobjectfacultatif
listingIdstringfacultatif
siteIdintegerfacultatif
optedOutbooleanfacultatif
canceledOrderItemIdsarray of stringfacultatif
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.
409L’établissement doit être archivé, une identité en double existe ou les contrôles ont bloqué l’action.
422L’opération nécessite une intervention ou n’a pas pu être effectuée.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503L’opération nécessite une intervention ou n’a pas pu être effectuée.
post/api/v1/listings/opt-out
Votre clé API
Corps de la requête*
{}

Guides qui utilisent cette ressource