Synup
Créer une clé
v1Ressources/AEO/postMettre à jour les champs des prompts AEO

Mettre à jour les champs des prompts AEO

Crée, renomme ou archive un champ personnalisé des prompts AEO suivis d'un site web, ou définit des valeurs sur ses prompts actifs ou en pause. Envoyez locationId, un mutationId et une command. Les champs sont de simples annotations : ils ne changent ni ce que mesurent les vérifications de prompts, ni ce qu'elles consomment. Tant que la gestion des prompts est désactivée pour l'agence, les champs restent lisibles mais ne peuvent pas être modifiés.

post/api/v1/aeo/prompts/fields
aeo:write
Corps de la requête
locationIdstringobligatoire
ID de l'établissement dont vous modifiez le jeu de champs. Pour les prompts AEO, le site web.
mutationIdstringobligatoire
Un UUID que vous choisissez pour cette modification. Le renvoyer avec la même command renvoie le premier résultat sans réappliquer la modification ; le réutiliser avec une autre command renvoie 409.
commandobjectobligatoire
Une modification. field_create ajoute un champ avec label, type et options. field_update renomme un champ, modifie ses options, ou l'archive ou le restaure, et exige la version actuelle du champ comme expectedVersion. values_update définit de 1 à 1000 valeurs, chacune avec recordId, fieldId, value et expectedVersion, et les applique toutes ou aucune. Une option encore utilisée par des enregistrements ne peut pas être supprimée ; archivez-la plutôt. Un jeu de champs contient au maximum 40 champs, champs archivés compris.
Réponse
dataobjectfacultatif
resultobjectfacultatif
Ce que la modification a fait : l'id du champ pour field_create et field_update, ou le nombre de valeurs écrites pour values_update.
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.
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).
413Le corps de la requête dépasse 1 Mo.
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.
post/api/v1/aeo/prompts/fields
Votre clé API
Corps de la requête*
{}

Guides qui utilisent cette ressource