PUT /api/v3/apiKey/{apiKeyId}

Updates the name and description of an existing API key

EditApiKeyV3 Permissions: ApplicationSettings (Manage)

Use this endpoint to modify an API key’s name or description. The key value and associated user cannot be changed. Requires Application Settings Manage permission.

Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type, including the request body.

Path Parameters

Name	Description	Type	Required
apiKeyId	Unique numeric identifier of the API key to update	integer (int32)	Required

Request Body

ApiKeyEditRequest

Property	Description	Type
apiKeyDescription	A description for the API key Required (defined)	string
apiKeyName	The name of the API key Required Must be between 0 and 60 characters	string

Example Request Body application/json

{  "apiKeyDescription": "string",  "apiKeyName": "string"
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

ApiKeyResponse

Property

Description

Type

apiKeyDescription

A description of the API key

string

apiKeyId

The identifier of the API key

integer (int32)

apiKeyName

The name of the API key

string

createdBy

UserChild

UserChild properties

Property	Description	Type
fullName	The user’s full name	string
userCode	The user code	string
userId	The user identifier	integer (int32)

createdDate

The API key creation date

string (date-time)

Example Response application/json

{  "apiKeyDescription": "string",  "apiKeyId": 1,  "apiKeyName": "string",  "createdBy": {    "fullName": "string",    "userCode": "string",    "userId": 1
  },  "createdDate": "2026-06-29"
}

404 Not Found The requested resource was not found. Verify the ID or path is correct.