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

    To use this endpoint, you need an [API key]({{site.baseurl}}/api/basics#rest-api-key-permissions) with `data_objects.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}:
    delete:
      summary: Delete data object
      operationId: delete_data_objects_objects_type_name_object_id_delete_data_object
      parameters:
        - name: type_name
          in: path
          required: true
          description: Data object type machine name.
          schema:
            type: string
          example: account
        - name: object_id
          in: path
          required: true
          description: Object identifier.
          schema:
            type: string
          example: acct-123
      responses:
        "200":
          description: |
            The request succeeded and the object was deleted. No action needed.

            The status code `200` could return the following response body.

            The delete is synchronous. Deleting one object does not delete related objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataObjectResponse'
              examples:
                deleted:
                  summary: Object deleted
                  description: This example deletes the `acct-123` account record.
                  value:
                    deleted: true
        "400":
          description: |
            Bad request. A value or field name in the request body, path, or query isn't valid UTF-8 or contains the null character. Remove the invalid characters. The `invalid_request` error names each affected field in `source` and doesn't include the value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                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
        "404":
          description: |
            Not found. Type not found or object not found. Confirm `type_name` and `object_id` both exist in the workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                type_not_found:
                  summary: Type not found
                  value:
                    errors:
                      - id: data-object-type-not-found
                        message: Data object type not found.
                        parameters:
                          - type_name
                        parameter_values:
                          - account
                object_not_found:
                  summary: Object not found
                  value:
                    errors:
                      - id: data-object-not-found
                        message: Data object not found.
                        parameters:
                          - type_name
                          - object_id
                        parameter_values:
                          - account
                          - acct-123
        "401":
          description: |
            Unauthorized. Missing or invalid REST API key. Verify the `Authorization` header uses `Bearer YOUR_REST_API_KEY` and that the key is active. Send the key to the correct [REST endpoint]({{site.baseurl}}/api/basics/#endpoints). For more causes, see [Errors and responses]({{site.baseurl}}/api/errors/#fatal-errors).
          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.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_allowlisted:
                  summary: Source IP not on the key allowlist
                  value:
                    error: IP address 203.0.113.10 is not whitelisted
        "429":
          description: |
            Too many requests. Rate limit exceeded. Retry after `X-RateLimit-Reset` and reduce request frequency. See [API rate limits]({{site.baseurl}}/api/api_limits/).
          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.delete` permission.
        Pass the key as `Authorization: Bearer YOUR_REST_API_KEY`.
  schemas:
    DeleteDataObjectResponse:
      title: Delete data object response
      type: object
      required: [deleted]
      properties:
        deleted:
          type: boolean
          description: Whether the object deletion succeeded.
          example: true
    ErrorDetail:
      title: Error detail
      type: object
      properties:
        id:
          type: string
          description: Machine-readable error identifier, such as `data-object-not-found`.
        message:
          type: string
          description: Human-readable error message.
        parameters:
          type: array
          description: Names of the request parameters the error refers to.
          items:
            type: string
        parameter_values:
          type: array
          description: Values of those parameters in the request.
          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 returned for authentication, permission, and some validation errors.
        errors:
          type: array
          description: Optional list of detailed validation errors.
          items:
            $ref: '#/components/schemas/ErrorDetail'
