Skip to main content
PUT
/
tools
/
credentials
/
{credential_id}
Update Tool Credential
curl --request PUT \
  --url https://agent-prod.studio.lyzr.ai/v3/tools/credentials/{credential_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "string",
  "credentials": {},
  "meta_data": {}
}
'
{
  "message": "Credential updated successfully."
}

Documentation Index

Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Update an existing tool credential by its ID.

​
Endpoint

PUT /v3/tools/credentials/{credential_id}

​
Authentication

API Key (x-api-key) must be included in the header.

​
Path Parameters

  • credential_id (string) - The ID of the credential to update.

​
Request Body

A JSON object containing the updated credential data.

​
Response

A message confirming that the credential was updated.

​
Example Request

curl -X PUT "https://agent-prod.studio.lyzr.ai/v3/tools/credentials/credential_id" ^
-H "accept: application/json" ^
-H "content-type: application/json" ^
-H "x-api-key: sk-default-EXAMPLEKEY123" ^
-d "{\"name\":\"string\",\"credentials\":{},\"meta_data\":{}}"

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
credential_id
string
required

The ID of the credential to update.

Body

application/json

Updated credential data

​
name
string
Example:

"string"

​
credentials
object
​
meta_data
object

Response

Credential updated successfully

​
message
string
Example:

"Credential updated successfully."