Skip to main content

Credential by ID API

Update settings or delete an individual API credential.

PUT /secrets/{id}

Update settings on an existing credential, such as the upstream consent trust flag.

Request

ParameterTypeRequiredDescription
idstringYesCredential identifier (path parameter)

Request Body

FieldTypeRequiredDescription
trust_upstream_consentbooleanYesWhether to trust consent status provided by the upstream system when ingesting events with this credential
{
"trust_upstream_consent": true
}

Response

204 No Content

Example

curl -X PUT "https://api.leadvibe.com/secrets/sec_abc123" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"trust_upstream_consent": true}'

Common Errors

StatusMeaningSolution
400Bad RequestEnsure trust_upstream_consent is provided as a boolean
401UnauthorizedCheck authentication credentials

DELETE /secrets/{id}

Permanently delete an API credential. Any integrations using this credential will stop working immediately.

Request

ParameterTypeRequiredDescription
idstringYesCredential identifier (path parameter)

Response

204 No Content

Example

curl -X DELETE "https://api.leadvibe.com/secrets/sec_abc123" \
-H "Authorization: Bearer <token>"

Common Errors

StatusMeaningSolution
400Bad RequestActive OU must be set
401UnauthorizedCheck authentication credentials

Notes

  • Deleting a credential is irreversible and immediately revokes access for any system using it
  • Before deleting, verify no active integrations depend on the credential
  • Consider rotating credentials (create a new one, update integrations, then delete the old one) instead of deleting in-place