Skip to main content
PUT
/
oauth
/
apps
/
{clientId}
Update OAuth application
curl --request PUT \
  --url http://sandbox.mintlify.com/oauth/apps/{clientId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Integration",
  "description": "Integration for managing organization data",
  "redirectUri": "https://example.com/callback",
  "scopes": [
    "read:organization",
    "write:organization"
  ],
  "isActive": true
}
'
Updates an OAuth application configuration. Only OWNERS and ADMINS can update OAuth applications.
Client ID and secret cannot be changed. Only name, description, redirect URI, scopes, and status can be updated.

​
Permissions

Only OWNERS and ADMINS can update OAuth applications.

​
Path Parameters

ParameterTypeRequiredDescription
clientIdstringYesOAuth application client ID

​
Request Body

FieldTypeRequiredDescription
namestringNoApplication name (max 100 characters)
descriptionstringNoApplication description (max 500 characters)
redirectUristringNoRedirect URI for OAuth flow
scopesarrayNoOAuth scopes requested
isActivebooleanNoWhether the application is active

​
Example Request

curl -X PUT http://localhost:3001/api/oauth/apps/app_1234567890abcdef \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Integration Name",
    "scopes": ["read:organization", "write:organization", "read:webhooks"],
    "isActive": true
  }'

​
Example Response

{
  "clientId": "app_1234567890abcdef",
  "name": "Updated Integration Name",
  "description": "Integration for managing organization data",
  "redirectUri": "https://example.com/callback",
  "scopes": ["read:organization", "write:organization", "read:webhooks"],
  "isActive": true,
  "updatedAt": "2025-01-26T11:00:00Z"
}

​
Common Errors

​
400 Bad Request

Invalid input data or validation errors.

​
401 Unauthorized

Authentication required.

​
403 Forbidden

Only owners and admins can update OAuth applications.

​
404 Not Found

OAuth application not found with the provided client ID.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
clientId
string
required

Body

application/json
​
name
string

Application name

Maximum string length: 100
Example:

"My Integration"

​
description
string

Application description

Maximum string length: 500
Example:

"Integration for managing organization data"

​
redirectUri
string

Redirect URI for OAuth flow

Example:

"https://example.com/callback"

​
scopes
array[]

OAuth scopes requested

Example:
["read:organization", "write:organization"]
​
isActive
boolean

Whether the application is active

Example:

true

Response

Application updated successfully with new configuration.