Update an API key
Update the name of an existing API key for your merchant account. This allows you to change the descriptive name that helps identify the key's purpose.
The key's actual value and functionality remain unchanged - only the display name is modified.
key_id
string
Required. The unique identifier of the API key you want to update. This ID was provided when the key was first generated.
name
string
Required. The new descriptive name for the key. Choose a name that clearly identifies the key's purpose and usage context.
NOT_FOUND
This error occurs when no active API key with the provided ID exists in your merchant account.
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.
curl "https://api.reservepay.com/merchants/update-key" \
-X POST
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
-d '{
"key_id": "key_OtjnE29kU1",
"name": "My Application (backup)"
}'