v1Ressourcen/AEO/postAEO-Prompt-Felder aktualisieren

AEO-Prompt-Felder aktualisieren

Erstellt, benennt um oder archiviert ein benutzerdefiniertes Feld der getrackten AEO-Prompts einer Website oder setzt Werte für ihre aktiven oder pausierten Prompts. Senden Sie locationId, eine mutationId und einen command. Felder sind reine Anmerkungen: Sie ändern weder, was Prompt-Prüfungen messen, noch was sie verbrauchen. Solange die Prompt-Verwaltung für die Agentur ausgeschaltet ist, bleiben Felder lesbar, können aber nicht geändert werden.

post/api/v1/aeo/prompts/fields
aeo:write
Anfragetext
locationIdstringerforderlich
ID des Standorts, dessen Feldsatz Sie ändern. Bei AEO-Prompts die Website.
mutationIdstringerforderlich
Eine von Ihnen gewählte UUID für diese Änderung. Erneutes Senden mit demselben command gibt das erste Ergebnis zurück, ohne die Änderung erneut anzuwenden; Wiederverwendung mit einem anderen command gibt 409 zurück.
commandobjecterforderlich
Eine Änderung. field_create fügt ein Feld mit label, type und options hinzu. field_update benennt ein Feld um, ändert seine Optionen oder archiviert bzw. reaktiviert es und benötigt die aktuelle Version des Felds als expectedVersion. values_update setzt 1 bis 1000 Werte, jeweils mit recordId, fieldId, value und expectedVersion, und wendet alle oder keinen an. Eine Option, die Datensätze noch verwenden, kann nicht entfernt werden; archivieren Sie sie stattdessen. Ein Feldsatz enthält höchstens 40 Felder, archivierte eingeschlossen.
Antwort
dataobjectoptional
resultobjectoptional
Was die Änderung bewirkt hat: die ID des Felds bei field_create und field_update oder die Anzahl der geschriebenen Werte bei values_update.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).
413Der Request-Body ist größer als 1 MB.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Befolgen Sie die Hinweise zur Wiederholung für diesen Vorgang.
post/api/v1/aeo/prompts/fields
Ihr API-Schlüssel
Anfragetext*
{}

Anleitungen, die diese Ressource verwenden