Update a managerial key type

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

Relabel, reorder, or (de)activate a key type. Updating a built-in default materialises its definition row.

Operation ID: update_managerial_key_type_api_v1_businesses__business_id__managerial_key_mappings_key_types__key__put·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

Request body

Schema: ManagerialKeyTypeUpdateRequest

labelstring
descriptionstring
sort_orderinteger
is_activeboolean

Responses

200Successful Response

Schema: SuccessEnvelope_ManagerialKeyTypeResponse_

successboolean
messagestring
codestring
dataManagerialKeyTypeResponse

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

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

bash

curl -X PUT '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' \
  -H 'Content-Type: application/json' \
  -d '{
  "label": "string",
  "description": "string",
  "sort_order": 0,
  "is_active": false
}'