v2

latestOpenAPI 3.1.02026-08-0858116535.1 KB
Websets

Update a Webset

post/v0/websets/{id}

Path parameters

idstring required

The id or externalId of the Webset

Request body

metadataobject nullable

Set of key-value pairs you want to associate with this object.

titlestring

Optional name that appears anywhere the Webset is displayed.

Example request

{
  "title": "Leading climate tech startups"
}

Response

Webset updated

idstring required

The unique identifier for the webset

object'webset' required
status'idle' | 'pending' | 'running' | 'paused' required

The status of the webset

externalIdstring nullable required

The external identifier for the webset

titlestring nullable required

The title of the webset

metadataobject

Set of key-value pairs you want to associate with this object.

dashboardUrlstring uri required

The URL to view the webset in the Exa dashboard

createdAtstring date-time required

The date and time the webset was created

updatedAtstring date-time required

The date and time the webset was updated