Delete a managerial key type

DELETE/api/v1/businesses/{business_id}/managerial-key-mappings/key-types/{key}

Remove a key type. Refused while the key still has ledger mappings unless force=true, which deletes those mappings too. Built-in defaults are deactivated rather than removed.

Operation ID: delete_managerial_key_type_api_v1_businesses__business_id__managerial_key_mappings_key_types__key__delete·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired
keystringrequired

Query

forcebooleandefault: False: Also delete this key type's ledger mappings.

Responses

200Successful Response

Schema: SuccessEnvelope_ManagerialKeyTypeDeleteResponse_

successboolean
messagestring
codestring
dataManagerialKeyTypeDeleteResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

DELETE/api/v1/businesses/{business_id}/managerial-key-mappings/key-types/{key}

bash

curl -X DELETE 'https://api.ondayzero.com/api/v1/businesses/{business_id}/managerial-key-mappings/key-types/{key}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'