---
title: "Update an App Client"
method: PATCH
path: "/v2/app_clients/{app_client_id}"
tags: ["Application Clients"]
---

# Update an App Client

`PATCH /v2/app_clients/{app_client_id}`

Updates the configuration of an existing App Client.

## Path parameters

- `app_client_id` string, required

## Headers

- `Request-Timeout` integer
- `Request-Timeout-Millis` integer

## Request body

- UpdateAppClientRequest — Request to update an existing OAuth application client's properties.
  - `description` string — The new App Client description.
  - `api_roles` ApiRole[] — The new roles attached to the App Client. These roles replace the current roles.
  - `corpus_roles` CorpusRole[] — The new corpus role assignments. These replace the current corpus roles.
    - `corpus_key` string, required — The key of the corpus this role applies to.
    - `role` 'owner' | 'administrator' | 'viewer' | 'editor', required — The role assigned for this specific corpus.
  - `agent_roles` AgentRole[] — The new agent role assignments. These replace the current agent roles.
    - `agent_key` string, required — The key of the agent this role applies to.
    - `role` 'agent_administrator' | 'agent_viewer' | 'agent_developer' | 'agent_user' | 'agent_end_user', required — The role assigned for this specific agent. * `agent_administrator` - Full administrative access to the agent including deletion and configuration. * `agent_viewer` - Read-only access to view agent configuration, sessions, events, instructions, and tools. * `agent_developer` - Can modify agent configuration, create/manage sessions, update tools and instructions. * `agent_user` - Limited access to interact with the agent by creating sessions and sending inputs. Cannot view agent configuration or modify settings. * `agent_end_user` - Granted on an alias, lets a user create sessions and send messages through it. They see only their own sessions, and within them only their own messages and the agent's replies. This must be the only role the user holds. The platform rejects assigning it alongside any other role.

## Response `200`

The App Client.

- AppClient — An OAuth application client configuration used for authentication.
  - `id` string, required — The Vectara App Client ID. This ID is not used during an OAuth flow. Use this ID within the Vectara API.
  - `name` string, required — The human-readable name of the App Client.
  - `description` string — Description of the App Client.
  - `client_id` string, required — The client ID used with the OAuth flow.
  - `client_secret` string, required — The client secret used in API requests. Keep the secret secure.
  - `api_roles` ApiRole[] — The API roles attached to the App Client.
  - `corpus_roles` CorpusRole[] — Corpus-specific role assignments for this App Client.
    - `corpus_key` string, required — The key of the corpus this role applies to.
    - `role` 'owner' | 'administrator' | 'viewer' | 'editor', required — The role assigned for this specific corpus.
  - `agent_roles` AgentRole[] — Agent-specific role assignments for this App Client.
    - `agent_key` string, required — The key of the agent this role applies to.
    - `role` 'agent_administrator' | 'agent_viewer' | 'agent_developer' | 'agent_user' | 'agent_end_user', required — The role assigned for this specific agent. * `agent_administrator` - Full administrative access to the agent including deletion and configuration. * `agent_viewer` - Read-only access to view agent configuration, sessions, events, instructions, and tools. * `agent_developer` - Can modify agent configuration, create/manage sessions, update tools and instructions. * `agent_user` - Limited access to interact with the agent by creating sessions and sending inputs. Cannot view agent configuration or modify settings. * `agent_end_user` - Granted on an alias, lets a user create sessions and send messages through it. They see only their own sessions, and within them only their own messages and the agent's replies. This must be the only role the user holds. The platform rejects assigning it alongside any other role.
  - `api_policy` ApiPolicy — The actions a principal can take on the Vectara platform.
    - `name` string, required — The name of the API role.
    - `allowed_operations` object, required — The operations the API role allows. Each operation may allow only certain resources, described by a map of resource path to resource values. If the value is null, the operation allows any resource.

## Other responses

- `403` — Permissions do not allow updating this App Client.

---

[API](https://skmtc.net/vectara/apis/vectara-rest-api-v2.md) · [All operations](https://skmtc.net/vectara/apis/vectara-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vectara/vectara-rest-api-v2/revisions/fca567a46b3a/schema)