Skip to main content
PATCH
/
api
/
v1
/
evaluations
/
{id}
Update an evaluation
curl --request PATCH \
  --url https://app.autousers.ai/api/v1/evaluations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "sharePassword": "<string>",
  "shareRequireEmail": true,
  "shareRequireName": true,
  "shareAllowAnon": true,
  "shareExpiry": "<string>",
  "allowMultipleRatings": true,
  "editorsCanShare": true,
  "useProxy": true,
  "proxyRegion": "<string>"
}
'
{
  "id": "<string>",
  "teamId": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "links": {
    "preview": "<string>",
    "review": "<string>",
    "edit": "<string>",
    "results": "<string>",
    "share": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Client-generated idempotency key (≤255 chars). Replays the cached response when the same (team, key) pair sees an identical request body within 24h; returns 409 idempotency_key_reused if the body differs. Recommended for every billable POST.

Maximum string length: 255
​
Autousers-Version
string

Date-pinned API version (e.g. 2026-05-04). Omit to receive the latest stable version. Behaves like Stripe's Stripe-Version — pinning a version freezes payload shapes against breaking changes during the 12-month sunset window.

Path Parameters

​
id
string
required

cuid of the resource

Body

application/json
​
id
string<cuid>
​
teamId
string<cuid>
​
name
string
Required string length: 1 - 200
​
description
string
Maximum string length: 2000
​
type
enum<string>
Available options:
SSE,
SxS
​
status
enum<string>
Available options:
Draft,
Running,
Ended,
Archived
​
shareAccess
enum<string>
Available options:
TEAM_ONLY,
AUTOUSERS_LINK,
ANYONE_WITH_LINK,
PASSWORD_PROTECTED
​
sharePassword
string
Minimum string length: 1
​
shareRequireEmail
boolean
​
shareRequireName
boolean
​
shareAllowAnon
boolean
​
shareExpiry
string | null
​
allowMultipleRatings
boolean
​
editorsCanShare
boolean
​
browserEngine
enum<string> | null
Available options:
CHROME,
CAMOUFOX
​
useProxy
boolean | null
​
proxyRegion
string | null
Minimum string length: 1
​
modelId
enum<string> | null
Available options:
gemini-3-flash-preview,
gemini-2.5-computer-use-preview-10-2025

Response

Updated

​
id
string
required
​
teamId
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
SSE,
SxS
​
status
enum<string>
required
Available options:
Draft,
Running,
Ended,
Archived
​
shareAccess
enum<string>
required
Available options:
TEAM_ONLY,
AUTOUSERS_LINK,
ANYONE_WITH_LINK,
PASSWORD_PROTECTED
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
description
string | null
​
links
object
​
{key}
any