Apps

Update app

Update a Custom App in the current organization.

PATCH/apps/{slug}

Update a Custom App. Send only the fields you want to change. The slug stays the same when you change name.

An admin or a member can call this. Turning off require_password_to_launch needs a user session token and the account password.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Path

slugstringrequiredpath

slug from Get app.

Body

namestringbody

Name shown in the Apps library. This does not change slug.

descriptionstringbody

Short explanation of what the app does.

logo_urlstringbody

Public URL of the app logo.

developer_namestringbody

Company, team, or person that built the app.

registration_callback_urlstringbody

Absolute http or https URL Blnk calls on install and uninstall. It cannot include credentials, and it cannot target localhost or a private address.

portal_generator_urlstringbody

Absolute http or https URL Blnk calls to open the app. Same address rules as registration_callback_url.

permissionsstring[]body

Scopes the app can be granted: data:read, data:write, alerts:read, and alerts:write. Omit this to leave the current scopes. Send a list to replace them.

is_privatebooleanbody

true keeps the app in the current organization. false removes it from that library and clears assigned_to.

assigned_tostring[]body

User ids allowed to launch the app, from List team members. Sending this replaces the current list, and an empty array means every member. The list is kept only when the app is private.

require_password_to_launchbooleanbody

Whether every launch asks for the account password again. Turning this from true to false needs a session token, password, and two_factor_code when 2FA is on.

passwordstringbody

Account password of the signed-in user. Required when you set require_password_to_launch to false.

two_factor_codestringbody

2FA code. Required with password when 2FA is on for this user.

Response

A 200 response returns the updated app. The fields match Get app.

app_idstringrequired

Id of the app (app_...).

slugstringrequired

Identifier of the app. Unchanged by this call.

namestringrequired

Name shown in the Apps library.

permissionsstring[]

Scopes the app can be granted.

assigned_tostring[]

User ids allowed to launch the app. Empty means every member.

require_password_to_launchbooleanrequired

Whether a launch asks for the account password again.

updated_atstringrequired

When the app was last updated.

curl -X PATCH "https://api.cloud.blnkfinance.com/apps/stripe-sync" \
  -H "X-blnk-key: CLOUD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Sync Stripe payments and payouts into the ledger."
  }'

{
  "app_id": "app_049495fe-6f03-4e7b-b3b4-7b0466c127c7",
  "slug": "stripe-sync",
  "name": "Stripe Sync",
  "description": "Sync Stripe payments and payouts into the ledger.",
  "logo_url": "https://app.example.com/logo.png",
  "developer_name": "Example",
  "registration_callback_url": "https://app.example.com/api/callback",
  "portal_generator_url": "https://app.example.com/api/portal",
  "permissions": ["data:read", "data:write"],
  "is_private": true,
  "organization_id": "org_01K4EX0C3A9F2B7D6E1C8A5F40",
  "assigned_to": [],
  "require_password_to_launch": false,
  "created_at": "2026-04-21T12:00:00Z",
  "updated_at": "2026-04-21T12:10:00Z"
}

{
  "error": "App not found"
}

{
  "error": "invalid app permission \"billing:read\" (allowed: data:read, data:write, alerts:read, alerts:write)"
}

{
  "error": "registration_callback_url must be an absolute http or https URL"
}

{
  "error": "disabling app launch password requires a user session token"
}

{
  "error": "password is required to disable app launch password"
}

{
  "error": "two_factor_code is required"
}

{
  "error": "password verification failed"
}

{
  "error": "2fa verification failed"
}

{
  "error": "assigned_to must contain only active team members of this organization"
}

{
  "error": "Organization not found"
}