Datenobjekt ersetzen

Verwenden Sie diesen Endpunkt, um ein Datenobjekt mit vollständiger Attributersetzungssemantik zu erstellen oder zu ersetzen.

Wichtig

Datenobjekte befinden sich derzeit im Early Access. Ihr Workspace muss aktiviert sein, bevor die API-Schlüssel-Berechtigungen für Datenobjekte unter Einstellungen > API-Schlüssel angezeigt werden.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung data_objects.update.

Rate-Limit

Dieser Endpunkt befindet sich im Datenobjekte-Schreib-Bucket mit einem Standardlimit von 50 Anfragen pro Minute.

Pfadparameter

Die folgende Tabelle listet und beschreibt die Pfadparameter für den Endpunkt /data_objects/objects/{type_name}/{external_id}.

Anfrageparameter

Die folgende Tabelle listet und beschreibt die JSON-Anfrageparameter für den Endpunkt /data_objects/objects/{type_name}/{external_id}.

Beispielanfrage

Dieser Abschnitt enthält ein JSON-Beispiel-Payload und eine cURL-Beispielanfrage.

Beispiel-Anfrage-Payload

1
2
3
4
5

{
  "attributes": {
    "name": "Updated Account"
  }
}

cURL-Beispielanfrage

Dieses Beispiel ersetzt die gespeicherten Attribute von acct-123 durch die im Payload enthaltenen. Wenn kein Datensatz mit diesem Bezeichner existiert, erstellt diese Anfrage einen neuen.

1
2
3
4
5
6
7
8

curl --location --request PUT 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "attributes": {
    "name": "Updated Account"
  }
}'

Antwort

Dieser Abschnitt enthält eine beispielhafte erfolgreiche Antwort und die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 200 kann den folgenden Antwortkörper zurückgeben. Dieser Endpunkt gibt 200 zurück, unabhängig davon, ob die Anfrage das Objekt erstellt oder ersetzt hat.

1
2
3
4
5
6
7

{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Updated Account" }
  }
}

Antwortparameter

Die folgende Tabelle listet und beschreibt die Felder in einer erfolgreichen Antwort.

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt und wie Sie diese beheben können.