PUT
/
security
/
apiKeys
/
deactivate
cURL
curl -X PUT "https://dev.api.onekhusa.com/sandbox/v1/security/apiKeys/deactivate" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "Accept-Language: en" \
  -d '{
    "merchantAccountNumber": 67485577,
    "clientKey": "abcdefghijklmnopqrstuvwxyz1234",
    "changedBy": "admin@example.com"
  }'
"API key status has been changed successfully"

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer Token, Where accessToken is the access token used to authenticate the request.

Headers

Accept-Language
string
default:en

Preferred language for the response

Body

application/json

Request payload for deactivating a client API key

merchantAccountNumber
integer
required

The merchant account that owns the API key

Example:

67485577

clientKey
string
required

The client API key value to deactivate

Example:

"abcdefghijklmnopqrstuvwxyz1234"

changedBy
string
required

Email or identifier of the operator performing the deactivation

Example:

"admin@example.com"

Response

200 - application/json

Success - API key deactivated

The response is of type string.

Example:

"API key status has been changed successfully"