Datenobjekt erstellen
/data_objects/objects/{type_name}
Verwenden Sie diesen Endpunkt, um ein Datenobjekt für einen Typ zu erstellen.

Data Objects ist allgemein verfügbar, Ihr Workspace muss jedoch für Accounts bereitgestellt sein, bevor Sie diesen Endpunkt verwenden können. Um die Bereitstellung anzufordern, gehen Sie zu Dateneinstellungen > Accounts und füllen Sie den Fragebogen aus. Weitere Informationen finden Sie unter Accounts aktivieren.
Voraussetzungen
Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung data_objects.create.
Rate-Limit
Dieser Endpunkt gehört zum Data-Objects-Schreib-Bucket mit einem Standardlimit von 1000 Anfragen pro Minute.
Pfadparameter
Die folgende Tabelle listet und beschreibt die Pfadparameter für den Endpunkt /data_objects/objects/{type_name}.
| Parameter | Erforderlich | Datentyp | Beschreibung |
|---|---|---|---|
type_name |
Erforderlich | String | Maschinenname des Datenobjekttyps |
Anfrageparameter
Die folgende Tabelle listet und beschreibt die Parameter im JSON-Anfragebody für den Endpunkt /data_objects/objects/{type_name}.
| Parameter | Erforderlich | Datentyp | Beschreibung |
|---|---|---|---|
object_id |
Erforderlich | String | Objektbezeichner, eindeutig innerhalb des Typs. Darf nur Buchstaben, Zahlen, Bindestriche und Unterstriche enthalten und höchstens 250 Zeichen lang sein |
attributes |
Erforderlich | Objekt | Werte mit Feldnamen als Schlüssel, die anhand des Typschemas validiert werden |
display_name |
Optional | String | Anzeigebezeichnung für das Objekt. Wenn der Typ ein Quellfeld für den Anzeigenamen hat, hat der Wert dieses Feldes Vorrang. Standardmäßig object_id |
Beispielanfrage
Dieser Abschnitt enthält eine JSON-Beispiel-Payload und eine cURL-Beispielanfrage.
Beispiel-Payload der Anfrage
{
"object_id": "acct-new",
"attributes": {
"name": "New Account",
"industry": "software"
}
}
cURL-Beispielanfrage
Dieses Beispiel erstellt einen account-Datensatz mit dem Bezeichner acct-new und setzt dessen Attribute name und industry.
curl --location --request POST 'https://rest.iad-01.braze.com/data_objects/objects/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"object_id": "acct-new",
"attributes": {
"name": "New Account",
"industry": "software"
}
}'
Antwort
Dieser Abschnitt enthält ein Beispiel für eine erfolgreiche Antwort und die Antwortfelder.
Beispiel für eine erfolgreiche Antwort
Der Statuscode 201 könnte den folgenden Antwortbody zurückgeben.
{
"data_object": {
"type_name": "account",
"object_id": "acct-new",
"attributes": { "name": "New Account", "industry": "software" }
}
}
Antwortparameter
Die folgende Tabelle listet und beschreibt die Felder einer erfolgreichen Antwort.
| Parameter | Erforderlich | Datentyp | Beschreibung |
|---|---|---|---|
data_object |
Erforderlich | Objekt | Erstellter Datenobjekt-Datensatz |
data_object.type_name |
Erforderlich | String | Maschinenname des Datenobjekttyps |
data_object.object_id |
Erforderlich | String | Bezeichner des Datenobjekts |
data_object.attributes |
Erforderlich | Objekt | Gespeicherte Objektattribute mit Feldnamen als Schlüssel |
Fehler
Die folgende Tabelle listet häufige Fehler für diesen Endpunkt auf und beschreibt, wie Sie diese beheben können.
| Status | Ursache | Hinweis |
|---|---|---|
400 |
Unbekanntes Attributfeld oder ungültiger Attributtyp | Stellen Sie sicher, dass jedes Feld in attributes im Typschema existiert und den korrekten Datentyp verwendet. |
404 |
Typ nicht gefunden (data-object-type-not-found) |
Stellen Sie sicher, dass type_name im Workspace existiert und exakt dem Maschinennamen entspricht. |
409 |
Doppeltes Objekt (duplicate-data-object) |
Verwenden Sie eine andere object_id oder nutzen Sie PUT, um das bestehende Objekt zu ersetzen. |
422 |
Datensatzlimit erreicht (data-object-record-limit-exceeded) |
Reduzieren Sie die Objektanzahl für den Typ oder kontaktieren Sie den Braze-Support bezüglich Ihrer Workspace-Limits. |
401 |
Fehlender oder ungültiger REST-API-Schlüssel | Überprüfen Sie, ob der Authorization-Header Bearer YOUR_REST_API_KEY verwendet und der Schlüssel aktiv ist. |
403 |
API-Schlüssel hat keine Berechtigung oder die Anfrage wird durch die Allowlist blockiert | Stellen Sie sicher, dass der Schlüssel über data_objects.create verfügt und dass Ihre Quell-IP auf der Schlüssel-Allowlist steht, falls konfiguriert. |
429 |
Rate-Limit überschritten | Versuchen Sie es nach X-RateLimit-Reset erneut und reduzieren Sie die Anfragehäufigkeit. |