Update an OAuth app
Settings module
PATCH/oauth-apps/{id}oauthApps.update
An OAuth 2.1 client using PKCE. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability org.integrations.manage.
- OAuth scopes: org.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the oauth app. |
Request body: OauthAppUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | App name.Constraints: length 1 to 300 |
| redirect_uri | string (uri) | No | Registered redirect URI. |
{
"name": "Show Planner",
"redirect_uri": "https://northwindlive.example/files/site-plan.pdf"
}Response 200: OauthApp
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the oauth app. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | App name.Constraints: length 1 to 300 |
| client_id | string | Yes | OAuth client identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| redirect_uri | string (uri) | Yes | Registered redirect URI. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Show Planner",
"client_id": "xos_client_31f9",
"redirect_uri": "https://northwindlive.example/files/site-plan.pdf"
}Code samples
curl -X PATCH "$XOS_BASE_URL/oauth-apps/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"name":"Show Planner","redirect_uri":"https://northwindlive.example/files/site-plan.pdf"}'const { data, etag } = await xos.oauthApps.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"name": "Show Planner",
"redirect_uri": "https://northwindlive.example/files/site-plan.pdf"
}, { ifMatch: etag });response = xos.oauth_apps.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Show Planner", "redirect_uri": "https://northwindlive.example/files/site-plan.pdf"}, if_match=etag)xos oauth-apps update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Show Planner","redirect_uri":"https://northwindlive.example/files/site-plan.pdf"}' --if-match auto