Skip to main content
PATCH
/
tenants
/
{tenantId}
/
credentials
/
{credentialId}
cURL
# Update name
curl -X PATCH "https://api.arkhq.io/v1/tenants/cm6abc123def456/credentials/123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "new-name"}'

# Put on hold (disable)
curl -X PATCH "https://api.arkhq.io/v1/tenants/cm6abc123def456/credentials/123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hold": true}'

# Release from hold (enable)
curl -X PATCH "https://api.arkhq.io/v1/tenants/cm6abc123def456/credentials/123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hold": false}'
{ "success": true, "data": { "id": 123, "name": "production-smtp-v2", "type": "smtp", "hold": true, "lastUsedAt": "2026-02-03T10:30:00Z", "createdAt": "2026-01-15T08:00:00Z", "updatedAt": "2026-02-03T12:00:00Z" }, "meta": { "requestId": "req_abc123xyz" } }

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Path Parameters

​
tenantId
string
required

The tenant ID

​
credentialId
integer
required

The credential ID (numeric)

Body

application/json
​
name
string

New name for the credential

Required string length: 1 - 50
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"production-smtp-v2"

​
hold
boolean

Set to true to disable the credential (put on hold). Set to false to enable the credential (release from hold).

Example:

true

Response

Credential updated

​
success
boolean
required
​
data
object
required
​
meta
object
required