PATCH
/
v1
/
oauth-apps
/
{id}
curl --request PATCH \
  --url https://api.sequin.io/v1/oauth-apps/8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8 \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Arakkis - Stripe",
    "metadata": { "custom_property": 42 }
  }'
{
  "data": [
    {
      "id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "provider": "stripe",
      "name": "My Stripe OAuth App",
      "client_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "client_secret": "**********",
      "metadata": { "custom_property": 42 },
      // the health field is coming soon
      "health": {
        "status": "ok",
        "notes": [],
        "time": "2023-12-15 01:29:29"
      },
      "created_at": "2024-02-20T02:10:52Z",
      "updated_at": "2024-02-20T02:10:52Z"
    },
    { ... },
    { ... }
  ]
}

Request parameters

id
string
required

The ID of the OAuth app.

name
string

Name of the OAuth app.

client_secret
string

The client secret of the OAuth app.

metadata
object

Metadata for the OAuth app. This is a free-form object that you can use to store any additional information you want to associate with the OAuth app.

curl --request PATCH \
  --url https://api.sequin.io/v1/oauth-apps/8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8 \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Arakkis - Stripe",
    "metadata": { "custom_property": 42 }
  }'

Response fields

{
  "data": [
    {
      "id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "provider": "stripe",
      "name": "My Stripe OAuth App",
      "client_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "client_secret": "**********",
      "metadata": { "custom_property": 42 },
      // the health field is coming soon
      "health": {
        "status": "ok",
        "notes": [],
        "time": "2023-12-15 01:29:29"
      },
      "created_at": "2024-02-20T02:10:52Z",
      "updated_at": "2024-02-20T02:10:52Z"
    },
    { ... },
    { ... }
  ]
}
id
string

ID of the OAuth app.

name
string

Display name of the OAuth app.

health
object

Status of the OAuth app. Learn more about the health object.

provider
string

The provider of the OAuth app. See a list of supported providers here.

client_id
string

The client ID of the OAuth app.

client_secret
string

The client secret of the OAuth app.

metadata
object

Metadata for the OAuth app. This is a free-form object that you can use to store any additional information you want to associate with the OAuth app.

created_at
string

Timestamp of when the OAuth app was created, in ISO 8601 format.

updated_at
string

Timestamp of when the OAuth app was last updated, in ISO 8601 format.