---
openapi: 3.0.3
info:
  title: "Braze REST API \u2013 Delete object relationship"
  description: |
    ## Prerequisites

    To use this endpoint, you need an [API key]({{site.baseurl}}/api/basics#rest-api-key-permissions) with `data_objects.object_relationships.delete`.

    ## Rate limit

    This endpoint is in the Data Objects write bucket with a default limit of 1000 requests per minute.
  version: 1.0.0
  contact:
    name: Braze Support
    url: https://www.braze.com/docs/braze_support/
  license:
    name: Braze Documentation
    url: https://www.braze.com/docs/api/home/
servers:
- url: https://rest.iad-01.braze.com
  description: US-01
- url: https://rest.iad-02.braze.com
  description: US-02
- url: https://rest.iad-03.braze.com
  description: US-03
- url: https://rest.iad-04.braze.com
  description: US-04
- url: https://rest.iad-05.braze.com
  description: US-05
- url: https://rest.iad-06.braze.com
  description: US-06
- url: https://rest.iad-07.braze.com
  description: US-07
- url: https://rest.iad-08.braze.com
  description: US-08
- url: https://rest.us-10.braze.com
  description: US-10
- url: https://rest.fra-01.braze.eu
  description: EU-01
- url: https://rest.fra-02.braze.eu
  description: EU-02
- url: https://rest.au-01.braze.com
  description: AU-01
- url: https://rest.id-01.braze.com
  description: ID-01
- url: https://rest.jp-01.braze.com
  description: JP-01
- url: https://rest.kr-01.braze.com
  description: KR-01
security:
- BearerAuth: []
paths:
  /data_objects/objects/{type_name}/{object_id}/object_relationships:
    delete:
      summary: Delete object relationship
      operationId: delete_data_objects_objects_type_name_object_id_object_relationships_delete_object_relationship
      parameters:
        - name: type_name
          in: path
          required: true
          description: URL object type
          schema:
            type: string
          example: account
        - name: object_id
          in: path
          required: true
          description: URL object identifier
          schema:
            type: string
          example: acct-123
      requestBody:
        required: true
        description: |
          This `DELETE` endpoint expects a JSON request body. Validate that your HTTP client sends request bodies on `DELETE` calls.

          This section includes a sample JSON payload and a sample cURL request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteObjectRelationshipRequest'
            examples:
              delete_subaccount:
                summary: Delete a subaccount relationship
                description: This example removes the `subaccount` relationship between `acct-123` and `acct-456`. Both account records remain.
                value:
                  rel_kind: subaccount
                  related_type_name: account
                  related_object_id: acct-456
      responses:
        "200":
          description: |
            The request succeeded. This section includes a sample successful response and the response fields.

            The status code `200` could return the following response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteObjectRelationshipResponse'
              examples:
                success:
                  summary: Relationship deleted
                  value:
                    deleted: true
        "400":
          description: |
            Bad request. Validation error. Confirm the request body includes valid `rel_kind`, `related_type_name`, and `related_object_id` values.

            Braze also returns `400` with the `invalid_request` error code when a value or field name in the request body, path, or query isn't valid UTF-8 or contains the null character. The error names each affected field in `source` and doesn't include the value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unknown_rel_kind:
                  summary: Unknown relationship kind
                  value:
                    error: Object relationship type 'subaccount' not found.
                related_type_mismatch:
                  summary: Related type doesn't match the relationship kind
                  value:
                    error: Related data object type does not match relationship type 'subaccount'.
                invalid_characters:
                  summary: Value isn't valid UTF-8
                  value:
                    errors:
                      - id: 3f0c7a52-9b1e-4d6a-8c2f-5e7b1a9d4c60
                        status_code: 400
                        error_code: invalid_request
                        message: object_id must be valid UTF-8
                        source:
                          path: object_id
        "401":
          description: Unauthorized. Missing or invalid REST API key. The REST API key is missing, malformed, or sent to the wrong REST endpoint. Verify the `Authorization` header uses `Bearer YOUR_REST_API_KEY` and that the key is active.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_api_key:
                  summary: Missing or invalid API key
                  value:
                    error: Error authenticating credentials
        "403":
          description: Access denied. API key lacks permission or request is blocked by allowlist. Confirm the key has `data_objects.object_relationships.delete` and that your source IP is on the key allowlist, if configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                access_denied:
                  summary: Missing permission
                  value:
                    error: You do not have permission to access this resource
                ip_not_allowed:
                  summary: Source IP not on the key allowlist
                  value:
                    error: IP address 203.0.113.10 is not whitelisted
        "404":
          description: Not found. Relationship or endpoint object not found. Confirm both objects exist and the relationship key values match an existing edge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                relationship_not_found:
                  summary: Relationship not found
                  value:
                    errors:
                      - id: data-object-relationship-not-found
                        message: Data object relationship not found.
                object_not_found:
                  summary: Related object not found
                  value:
                    errors:
                      - id: data-object-not-found
                        message: Data object not found.
                        parameters:
                          - related_type_name
                          - related_object_id
                        parameter_values:
                          - account
                          - acct-456
        "429":
          description: Too many requests. Rate limit exceeded. Retry after `X-RateLimit-Reset` and reduce request frequency.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                over_rate_limit:
                  summary: Over rate limit
                  value:
                    errors:
                      - id: rate-limit-exceeded
                        message: You have exceeded your limit of 1000 requests per minute. Please contact your account executive to increase your limit. If you do not have their info, you may contact Braze directly at https://www.braze.com/contact/.
        5XX:
          description: |
            Internal server error. An unexpected error occurred on the Braze server. Retry with exponential backoff. If the error persists, contact [Support]({{site.baseurl}}/braze_support/).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: REST API key
      description: |
        REST API keys are created in the Braze dashboard at **Settings → APIs and
        Identifiers → API Keys**. The key must include the `data_objects.object_relationships.delete` permission.
        Pass the key as `Authorization: Bearer YOUR_REST_API_KEY`.
  schemas:
    DeleteObjectRelationshipRequest:
      title: Delete object relationship request
      type: object
      required: [rel_kind, related_type_name, related_object_id]
      properties:
        rel_kind:
          type: string
          description: Relationship kind
          example: subaccount
        related_type_name:
          type: string
          description: Related object type
          example: account
        related_object_id:
          type: string
          description: Related object identifier
          example: acct-456
    DeleteObjectRelationshipResponse:
      title: Delete object relationship response
      type: object
      required: [deleted]
      properties:
        deleted:
          type: boolean
          description: Whether the relationship deletion succeeded
          example: true
    ErrorDetail:
      title: Error detail
      type: object
      properties:
        id:
          type: string
          description: Error identifier, such as `data-object-relationship-not-found`.
        message:
          type: string
          description: Human-readable error message.
        parameters:
          type: array
          description: Request parameters the error applies to.
          items:
            type: string
        parameter_values:
          type: array
          description: Values sent for those parameters, in the same order.
          items:
            type: string
        status_code:
          type: integer
          description: HTTP status code. Included with `invalid_request` errors.
          example: 400
        error_code:
          type: string
          description: Error code, such as `invalid_request`. When it's present, `id` is a unique identifier for this error occurrence.
          example: invalid_request
        source:
          title: Error source
          type: object
          description: The request field the error applies to. Included with `invalid_request` errors.
          properties:
            path:
              type: string
              description: Dot-separated path to the field, such as `attributes.name`, when one field is affected.
            paths:
              type: array
              description: Dot-separated paths to each field, when more than one field is affected.
              items:
                type: string
    ErrorResponse:
      title: Error
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
        error:
          type: string
          description: Human-readable error message for authentication, permission, and argument errors.
        errors:
          type: array
          description: Optional list of detailed validation errors.
          items:
            $ref: '#/components/schemas/ErrorDetail'
