Skip to main content
Apps (BYOK)

Update an OAuth app

Change the name, image, or rotate the client secret. The clientId and platform are immutable: a refresh token is bound to the clientId that issued it, so changing the app would brick existing integrations — create a new OAuth app and reconnect instead.

PATCH/v1/apps/{id}

Authorization

accessKey
x-access-key<token>

In: header

Path Parameters

id*string

OAuth app ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/apps/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "app": {
    "id": "string",
    "platform": "twitter",
    "name": "string",
    "imageUrl": "string",
    "clientId": "string",
    "integrationCount": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}