Rename an agent
Updates the agent's non-versioned fields. Only the `name` can change here: the `type` is fixed at creation, and changing the configuration is creating a new version, not patching the agent.
Authorization
ApiKeyAuth A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).
In: header
Path Parameters
The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.
The agent id (prefixed agt_).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://example.com/api/v1/sites/string/agents/string" \ -H "Content-Type: application/json" \ -d '{ "name": "Storefront assistant (EU)" }'{ "data": { "id": "string", "siteId": "string", "name": "string", "type": "shopping_assistant", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z" }}