COconekta
Api Keys

Update Api Key

Update an existing api key

put/api_keys/{id}

Request

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Request body

activeboolean

Indicates if the webhook key is active

descriptionstring

A name or brief explanation of what this api key is used for

Example request

{
  "active": true,
  "description": "online store"
}

Response

successful operation

activeboolean

Indicates if the api key is active

created_atinteger

Unix timestamp in seconds of when the api key was created

updated_atinteger

Unix timestamp in seconds of when the api key was last updated

deactivated_atinteger nullable

Unix timestamp in seconds of when the api key was deleted

last_used_atinteger nullable

Unix timestamp in seconds with the api key was used

descriptionstring

A name or brief explanation of what this api key is used for

idstring

Unique identifier of the api key

livemodeboolean

Indicates if the api key is in production

objectstring

Object name, value is 'api_key'

prefixstring

The first few characters of the authentication_token

rolestring

Indicates if the api key is private or public

Example response

{
  "active": true,
  "created_at": 1684167881,
  "updated_at": 1684167923,
  "description": "online store",
  "id": "64625cc9f3e02c00163f5e4d",
  "object": "api_key",
  "prefix": "key_rp",
  "role": "private"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.