Supprimer une relation d’objet

Utilisez cet endpoint pour supprimer une arête de relation entre deux objets.

Important

Les objets de données sont en disponibilité générale, mais votre espace de travail doit être provisionné pour les comptes avant que vous puissiez utiliser cet endpoint. Pour demander le provisionnement, accédez à Paramètres des données > Comptes et remplissez le questionnaire. Pour plus de détails, consultez Activer les comptes.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API disposant de l’autorisation data_objects.object_relationships.delete.

Limite de débit

Cet endpoint fait partie du compartiment d’écriture des objets de données, avec une limite par défaut de 1 000 requêtes par minute.

Paramètres de chemin

Le tableau suivant répertorie et décrit les paramètres de chemin de l’endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Paramètres de requête

Le tableau suivant répertorie et décrit les paramètres du corps de requête JSON de l’endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Remarque

Cet endpoint DELETE attend un corps de requête JSON. Vérifiez que votre client HTTP envoie bien un corps de requête lors des appels DELETE.

Exemple de requête

Cette section comprend un exemple de payload JSON et un exemple de requête cURL.

Exemple de payload de requête

1
2
3
4
5

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456"
}

Exemple de requête cURL

Cet exemple supprime la relation subaccount entre acct-123 et acct-456. Les deux enregistrements de compte sont conservés.

1
2
3
4
5
6
7
8

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456"
}'

Réponse

Cette section comprend un exemple de réponse réussie et les champs de la réponse.

Exemple de réponse réussie

Le code de statut 200 peut renvoyer le corps de réponse suivant.

1

{ "deleted": true }

Paramètres de réponse

Le tableau suivant répertorie et décrit les champs d’une réponse réussie.

Erreurs

Le tableau suivant répertorie les erreurs courantes de cet endpoint et la manière de les résoudre.