Synup
Créer une clé
v1Ressources/Invitations à laisser un avis/getObtenir les champs des campagnes d'avis

Obtenir les champs des campagnes d'avis

Renvoie les champs personnalisés des campagnes d'avis d'un établissement, champs archivés compris, avec leurs valeurs, le tout dans une seule réponse.

get/api/v1/review-invites/campaign-fields
review-invite:read
Paramètres de requête
locationIdstringobligatoire
L'établissement dont les champs des campagnes d'avis sont renvoyés. Obligatoire.
Réponse
dataobjectfacultatif
Les champs personnalisés et les valeurs stockées pour un type d'enregistrement dans une portée.
agencyIdstringfacultatif
L'id de votre espace de travail (agence).
userIdstringfacultatif
L'id de la personne au nom de laquelle la requête s'exécute : le créateur de la clé API.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)facultatif
Le type d'enregistrement auquel appartient le jeu : local_keyword, task, aeo_prompt, post, series, review_campaign ou listing.
scopeIdstringfacultatif
L'id de la portée à laquelle appartient le jeu : l'établissement ou le client, le site web pour les prompts AEO, ou l'espace de travail pour les tâches.
canManagebooleanfacultatif
Indique si le créateur de la clé peut créer, renommer et archiver des champs dans ce jeu.
fieldsarray of objectfacultatif
Tous les champs du jeu, champs archivés compris, dans l'ordre d'affichage.
idstringfacultatif
L'id du champ. Utilisez-le comme fieldId pour définir des valeurs.
labelstringfacultatif
Le nom affiché du champ. Les noms sont uniques au sein d'un jeu de champs, champs archivés compris.
typestring (text | number | date | single_select | multi_select)facultatif
Le type de champ : text, number, date, single_select ou multi_select.
optionsarray of objectfacultatif
Les choix d'un champ single_select ou multi_select. Vide pour les autres types.
idstringobligatoire
L'id de l'option. Les valeurs de sélection stockent cet id, pas le libellé.
labelstringobligatoire
Le nom affiché de l'option, unique au sein du champ.
archivedbooleanfacultatif
True quand l'option est retirée : les valeurs qui la contiennent déjà la conservent, mais elle ne peut plus être sélectionnée.
versionintegerfacultatif
La version actuelle du champ, incrémentée à chaque modification. Transmettez-la comme expectedVersion dans field_update.
orderintegerfacultatif
La position du champ dans le jeu, à partir de 0.
archivedAtstringfacultatif
Date d'archivage du champ, ou null tant qu'il est actif. Les champs archivés sont toujours renvoyés.
valuesobjectfacultatif
Valeurs stockées, indexées par recordId puis par fieldId, chacune avec value et version. Seuls les enregistrements sans aucune valeur stockée sont omis ; une valeur effacée reste présente à null avec sa version stockée.
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.
503Le service est temporairement indisponible. Suivez les consignes de nouvelle tentative propres à cette opération.
get/api/v1/review-invites/campaign-fields
Votre clé API
locationId *
{}

Guides qui utilisent cette ressource