API Key
API Key - Update
API Key
API Key - Update
API Key - Update
Update information for the specified API Key.
POST
/
api_keys
/
{merchant_id}
/
{key_id}
Authorizations
api-key
string
headerrequiredAdmin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.
Path Parameters
merchant_id
string
requiredThe unique identifier for the merchant account
key_id
string
requiredThe unique identifier for the API Key
Body
application/json
name
string | null
A unique name for the API Key to help you identify it.
description
string | null
A description to provide more context about the API Key.
expiration
Available options:
never Response
200 - application/json
key_id
string
requiredThe identifier for the API Key.
merchant_id
string
requiredThe identifier for the Merchant Account.
name
string
requiredThe unique name for the API Key to help you identify it.
description
string | null
The description to provide more context about the API Key.
prefix
string
requiredThe first few characters of the plaintext API Key to help you identify it.
created
string
requiredThe time at which the API Key was created.
expiration
required
Available options:
never