# Delete record
- Operation ID: `deleteRecord`
- HTTP method: `DELETE`
- Path: `/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}`
- [Human-readable API reference](https://hub.synerise.com/api-reference/brickworks#tag/Brickworks:-Records/operation/deleteRecord)
## Self-contained OpenAPI method
The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required.
```yaml
openapi: 3.0.0
info:
title: Synerise Public API
version: 1.9.1
paths:
/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}:
delete:
tags:
- "Brickworks: Records"
summary: Delete record
description: |
Delete a record **permanently**. If you want to unpublish a record instead, send an update request to change the status to `UNPUBLISHED`
---
**API consumers:** Synerise User, Workspace (Business Profile)
**API key permission required:** `BRICKWORKS_RECORDS_DELETE`
**User role permission required:** `assets_brickworks: delete`
operationId: deleteRecord
security:
- JWT: []
parameters:
- name: SchemaIdentifier
in: path
required: true
description: Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)
schema:
oneOf:
- type: string
format: uuid
title: Schema UUID
- type: string
minLength: 3
maxLength: 25
pattern: ^(?!__)(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)[\w\-]+$
title: Schema AppId
examples:
uuid:
value: 550e8400-e29b-41d4-a716-446655440000
summary: Schema UUID
appId:
value: my_schema_app_id
summary: Schema AppId (API name)
- name: RecordIdentifier
in: path
required: true
description: Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)
schema:
oneOf:
- type: string
format: uuid
title: Record UUID
- type: string
minLength: 6
maxLength: 40
pattern: ^(?!__)(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)[\w\-]+$
title: Record slug
examples:
uuid:
value: f6ce33ee-bdf2-4a23-87be-07de936ceeab
summary: Record UUID
slug:
value: my-record-slug
summary: Record slug
responses:
"204":
description: Record deleted
"400":
description: Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"401":
description: "Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details."
content:
application/json:
schema:
type: object
x-class-name: GatewayError
x-interface-name-ts: GatewayError
properties:
error:
type: string
description: Summary of the error
status:
type: integer
format: int32
description: Status code
timestamp:
type: string
description: Time when the message was sent
message:
type: string
description: Description of the problem
"403":
description: Forbidden; insufficient permissions. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: GatewayError
x-interface-name-ts: GatewayError
properties:
error:
type: string
description: Summary of the error
status:
type: integer
format: int32
description: Status code
timestamp:
type: string
description: Time when the message was sent
message:
type: string
description: Description of the problem
"404":
description: Resource not found. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"409":
description: The request could not be completed due to a conflict with the current state of the resource. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"422":
description: The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"500":
description: See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
x-snr-doc-urls:
- /api-reference/brickworks#tag/Brickworks:-Records/operation/deleteRecord
servers:
- description: Microsoft Azure EU
url: https://api.synerise.com
- description: Microsoft Azure USA
url: https://api.azu.synerise.com
- description: Google Cloud Platform
url: https://api.geb.synerise.com
tags:
- name: "Brickworks: Records"
components:
schemas:
brickworks-service-ObjectsError:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
securitySchemes:
JWT:
type: http
scheme: bearer
description: |-
JWT Bearer token. The header looks like this: `Bearer {JWT}`
Remember to include the space between 'Bearer' and the token.
Generate a token via the **Authorization** endpoints.
```