Rename a version

Names a version of the agent, as Rename does in the dashboard. A name is a label, not configuration: no saved state changes, and a locked version (one that has been live or is part of an A/B test) can be renamed too. `null` or an empty name clears it, so the version reads as `V` followed by its number again. The version is the `lineId` of its saved states.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

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

siteId*string

The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.

id*string

The agent id (prefixed agt_).

lineId*string

The version id (prefixed agvl_): the lineId of its saved states.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*|

The new name, up to 60 characters. null or an empty string clears it.

Lengthlength <= 60

Response Body

`application/json`

`application/problem+json`

curl -X PATCH "https://example.com/api/v1/sites/string/agents/string/lines/string" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer sale"
  }'

curl -X PATCH "https://example.com/api/v1/sites/string/agents/string/lines/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Summer sale"  }'

{
  "data": {
    "id": "string",
    "agentId": "string",
    "number": 0,
    "name": "string",
    "label": "string",
    "locked": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "agentId": "string",    "number": 0,    "name": "string",    "label": "string",    "locked": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Rename a version

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/problem+json

401application/problem+json

404application/problem+json

429application/problem+json

500application/problem+json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`