Update App

curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New App Name",
    "logo": "data:image/webp;base64,UklGR...",
    "redirectUris": ["https://app.example.com/callback"],
    "defaultSuccessRedirectUri": "https://app.example.com/success",
    "defaultFailureRedirectUri": "https://app.example.com/error"
  }' \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH"

{
  "clientId": "HqTRDIYH",
  "clientSecret": "sh_app_...",
  "name": "New App Name",
  "logo": "data:image/webp;base64,UklGR...",
  "redirectUris": ["https://app.example.com/callback"],
  "providers": {
    "passport": { "enabled": true },
    "smartid": { "enabled": true, "config": { "useManagedCredentials": false, "rpUUID": "d278d410-...", "rpName": "Example" } },
    "mitid": { "enabled": false }
  },
  "defaultWorkflowId": "wf_6ec9b183",
  "workflows": [
    {
      "workflowId": "wf_6ec9b183",
      "name": "Default",
      "entryNodeId": "nd_231bba48",
      "nodes": [
        { "id": "nd_231bba48", "type": "request", "next": "nd_8fa2291e" },
        { "id": "nd_8fa2291e", "type": "verification", "next": "nd_9ea348df", "config": { "channel": "oidc", "claims": ["name", "given_name", "family_name", "birthdate"], "mode": "pii" } },
        { "id": "nd_9ea348df", "type": "response" }
      ],
      "createdAt": "2026-03-27T08:22:51.272Z",
      "updatedAt": "2026-03-27T08:22:51.272Z"
    }
  ],
  "organizationId": "org_...",
  "webhookConfig": {
    "enabled": false,
    "retryAttempts": 3,
    "timeoutSeconds": 10,
    "events": []
  }
}

PATCH

apps

{client_id}

curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New App Name",
    "logo": "data:image/webp;base64,UklGR...",
    "redirectUris": ["https://app.example.com/callback"],
    "defaultSuccessRedirectUri": "https://app.example.com/success",
    "defaultFailureRedirectUri": "https://app.example.com/error"
  }' \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH"

{
  "clientId": "HqTRDIYH",
  "clientSecret": "sh_app_...",
  "name": "New App Name",
  "logo": "data:image/webp;base64,UklGR...",
  "redirectUris": ["https://app.example.com/callback"],
  "providers": {
    "passport": { "enabled": true },
    "smartid": { "enabled": true, "config": { "useManagedCredentials": false, "rpUUID": "d278d410-...", "rpName": "Example" } },
    "mitid": { "enabled": false }
  },
  "defaultWorkflowId": "wf_6ec9b183",
  "workflows": [
    {
      "workflowId": "wf_6ec9b183",
      "name": "Default",
      "entryNodeId": "nd_231bba48",
      "nodes": [
        { "id": "nd_231bba48", "type": "request", "next": "nd_8fa2291e" },
        { "id": "nd_8fa2291e", "type": "verification", "next": "nd_9ea348df", "config": { "channel": "oidc", "claims": ["name", "given_name", "family_name", "birthdate"], "mode": "pii" } },
        { "id": "nd_9ea348df", "type": "response" }
      ],
      "createdAt": "2026-03-27T08:22:51.272Z",
      "updatedAt": "2026-03-27T08:22:51.272Z"
    }
  ],
  "organizationId": "org_...",
  "webhookConfig": {
    "enabled": false,
    "retryAttempts": 3,
    "timeoutSeconds": 10,
    "events": []
  }
}

Partially updates an app. All body fields are optional — supply only what you want to change.

Immutable fields: clientId and clientSecret cannot be changed via this endpoint. Attempts to include either field in the PATCH body will return 400 VALIDATION_INVALID_PARAMETER. To rotate the client secret, use POST /apps/{client_id}/rotate-client-secret.

Request

Authorization

string

required

Bearer <API_KEY> from Console > Developers > Workspace API Keys.

Content-Type

string

application/json

Path parameters

client_id

string

required

Client identifier of the app.

Request body

name

string

New display name for the app.

logo

string

App-level brand logo as a base64 data URL (for example data:image/webp;base64,...). Pass an empty string to remove the logo. Keep the encoded image small — the request body is limited to 1 MB.

redirectUris

string[]

Replaces the full list of allowed OAuth redirect URIs. Pass an empty array to clear all URIs.

webhookConfig

object

Partial webhook configuration. Merges with the existing config — fields you omit are preserved.

Show webhookConfig fields

webhookConfig.enabled

boolean

Enable or disable webhook delivery.

webhookConfig.url

string

HTTPS endpoint that receives webhook events.

webhookConfig.retryAttempts

number

Number of delivery retries on failure (default: 3).

webhookConfig.timeoutSeconds

number

Per-attempt timeout in seconds (default: 10).

webhookConfig.events

string[]

Event types to subscribe to. Pass an empty array to receive all events.

defaultSuccessRedirectUri

string

URI users are redirected to after a successful verification when no redirect_uri was supplied at session start.

defaultFailureRedirectUri

string

URI users are redirected to after a failed or cancelled verification when no redirect_uri was supplied at session start.

Response

Returns the updated App object.

curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New App Name",
    "logo": "data:image/webp;base64,UklGR...",
    "redirectUris": ["https://app.example.com/callback"],
    "defaultSuccessRedirectUri": "https://app.example.com/success",
    "defaultFailureRedirectUri": "https://app.example.com/error"
  }' \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH"

{
  "clientId": "HqTRDIYH",
  "clientSecret": "sh_app_...",
  "name": "New App Name",
  "logo": "data:image/webp;base64,UklGR...",
  "redirectUris": ["https://app.example.com/callback"],
  "providers": {
    "passport": { "enabled": true },
    "smartid": { "enabled": true, "config": { "useManagedCredentials": false, "rpUUID": "d278d410-...", "rpName": "Example" } },
    "mitid": { "enabled": false }
  },
  "defaultWorkflowId": "wf_6ec9b183",
  "workflows": [
    {
      "workflowId": "wf_6ec9b183",
      "name": "Default",
      "entryNodeId": "nd_231bba48",
      "nodes": [
        { "id": "nd_231bba48", "type": "request", "next": "nd_8fa2291e" },
        { "id": "nd_8fa2291e", "type": "verification", "next": "nd_9ea348df", "config": { "channel": "oidc", "claims": ["name", "given_name", "family_name", "birthdate"], "mode": "pii" } },
        { "id": "nd_9ea348df", "type": "response" }
      ],
      "createdAt": "2026-03-27T08:22:51.272Z",
      "updatedAt": "2026-03-27T08:22:51.272Z"
    }
  ],
  "organizationId": "org_...",
  "webhookConfig": {
    "enabled": false,
    "retryAttempts": 3,
    "timeoutSeconds": 10,
    "events": []
  }
}

Updatable fields: name, logo, redirectUris, webhookConfig, defaultSuccessRedirectUri, defaultFailureRedirectUri. Immutable fields (clientId, clientSecret) are silently ignored if included in the request body. To rotate the client secret use Rotate Client Secret.

Get App Delete App

Overview

Workspace

Apps

Providers

Provider Activation

Redirect URIs

Webhooks

Custom Domain

Workflows

Production Tests

Request

Path parameters

Request body

Response

​Request

​Path parameters

​Request body

​Response

Request

Path parameters

Request body

Response