VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List connected apps
Retrieve a connected app
Update a connected app
Disconnect an app

Update a connected app

Limits a connected app to reading, or lifts the limit.

Only the person signed in to the dashboard can.

Guide: Devices and apps

PATCH
/api/v1/me/connected-apps/{connectedAppId}

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

connectedAppId*string

The connected app's id, a UUID, as GET /me/connected-apps lists it.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

isReadOnly?|

true limits the app to reading; false lifts the limit.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/me/connected-apps/3f2b8c1e-7d4a-4e9b-a6c5-1d0f8e2b7a94" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "isReadOnly": true  }'
{  "id": "3f2b8c1e-7d4a-4e9b-a6c5-1d0f8e2b7a94",  "kind": "cli",  "clientName": "Voidhash CLI",  "reportedName": null,  "device": "grace-mbp",  "isReadOnly": true,  "connectedAt": "2026-02-01T08:10:00.000Z",  "lastUsedAt": "2026-03-14T09:20:00.000Z",  "idleExpiresAt": "2026-06-12T09:20:00.000Z"}
{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Expected object"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "dashboard_session_required",    "message": "Only you, signed in to Voidhash, can accept the Terms of Service; an app or key acting for you cannot."  }}
{  "error": {    "type": "not_found",    "code": "connected_app_not_found",    "message": "You have no connected app 3f2b8c1e-7d4a-4e9b-a6c5-1d0f8e2b7a94; it may have been disconnected.",    "param": "connectedAppId"  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

Errors

StatustypecodeWhen
403permission_denieddashboard_session_requiredFor any other credential.
404not_foundconnected_app_not_foundWhen the app is no longer connected.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Connected apps

  • List connected apps GET
  • Retrieve a connected app GET
  • Disconnect an app DELETE

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousRetrieve a connected appNextDisconnect an app

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Connected apps