1. API
  2. Records
  3. Record types

Record types: Delete

Description

Delete a record type along with all its records, their artifacts, and the record views built on it. Responds 204 No Content on success.

This is irreversible — the record type's data cannot be recovered. See the Get record type API to learn more about record types.

Request

HTTP Method: DELETE

URL: https://<tenant-domain>/api/v2/record_types/<<record_type_id>>

Path parameter Description
id The ID of the record type to delete.

Delete takes no request body or query parameters. An unknown query parameter or a non-empty request body returns a 400.

curl --proto '=https' --tlsv1.2 \
  -X DELETE \
  "https://<tenant-domain>/api/v2/record_types/<<record_type_id>>" \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request returns 204 No Content with no response body.

Errors

Errors are returned as a JSON object with an error field, along with an appropriate HTTP status code:

{
  "error": {
    "type": "not_found",
    "message": "Record type not found"
  }
}
Status Meaning
400 Invalid request — a malformed record type ID, an unknown query parameter, or a request body.
403 The tenant does not have access to records, or the caller lacks permission to delete this record type.
404 Record type not found, or the calling token does not have access to it.
408 The write timed out. Retry the request.

Errors are returned as { "error": { "type", "message" } }.

Was this helpful?
Record types: Delete | API | Tines