Skip to main content
PUT
/
apikeys
/
{apiKey}
Update
curl --request PUT \
  --url https://{appId}.api-{region}.cometchat.io/v3/apikeys/{apiKey} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "data": {
    "apiKey": "f1915e328e249ffaaafd97fb46a57ba55d233fbf",
    "name": "John's apiKey",
    "scope": "authOnly",
    "createdAt": 1625206799
  }
}
For the complete error reference, see Error Guide.

Authorizations

​
apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

​
apiKey
string
required

An apikey to update.

Body

application/json
​
name
string

Friendly name for the API key.

​
scope
enum<string>

Scope for the API key.

Available options:
authOnly,
fullAccess

Response

200 - application/json

Updated API Key

​
data
object