Update a user secret definition
PATCH
/api/companies/{companyId}/user-secret-definitions/{definitionId}Personal API keyConsole session
Update a user secret definition.
Authorization
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.
Path parameters
companyIdstringRequiredThe organization's id.
definitionIdstringRequiredThe definition's id.
Request body
application/json · required
namestringOptional
1–160 charactersdescriptionstring | nullOptional
at most 500 charactersstatusstringOptional
one of: "active", "disabled", "archived", "deleted"providerConfigIdstring (uuid) | nullOptional
providerMetadataobject | nullOptional
usageGuidancestring | nullOptional
at most 1000 charactersResponses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.