v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB

Credentials

Update a credential

Update a credential's name or hold status.

Hold Status:

When hold: true, the credential is disabled and cannot be used to send emails.
When hold: false, the credential is active and can send emails.
Use this to temporarily disable a credential without deleting it.

patch/tenants/{tenantId}/credentials/{credentialId}

Path parameters

tenantIdstring required

The tenant ID

credentialIdinteger required

The credential ID (numeric)

Request body

namestring

New name for the credential

holdboolean

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

Example request

{
  "name": "production-smtp-v2",
  "hold": true
}

Response

Credential updated

successtrue required

Example response

{
  "data": {
    "id": 123,
    "name": "production-smtp",
    "type": "smtp",
    "lastUsedAt": "2026-02-03T10:30:00Z",
    "createdAt": "2026-01-15T08:00:00Z",
    "updatedAt": "2026-02-03T10:30:00Z",
    "key": "cred_a1b2c3d4e5f6g7h8i9j0...",
    "smtpUsername": "cm6abc123def456/cred_a1b2c3d4e5f6g7h8i9j0..."
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}