Delete Record | Ediphai API

Delete one record. It is hidden from every view once the next build runs, and any later revision of it is refused with deleted. Needs the records:delete scope.

Authentication

AuthorizationBearer

ediphai_test_… or ediphai_live_…

Path parameters

record_typestringRequired

record_idstringRequired

Response

Deleted, or already deleted: the receipt with state deleted and a null hash

state"deleted"

record_typestring

record_idstring

revisioninteger-9007199254740991-9007199254740991

definitionobject

hashany

Null: a deleted record keeps no hash

countsmap from strings to integers

Results per definition section

outcomestringOptional

POST only. accepted: stored now. duplicate: this revision was already stored with the same envelope. valid: validate mode, nothing stored

currentbooleanOptional

POST only. false when a higher revision was already stored, so this one is kept as history

received_atstringOptional

When Ediphai stored it; absent in validate mode

Errors

4XX

Client Request Error

5XX

Server Error