Session replays

Save or unsave a session replay

POST/api/websites/{websiteId}/replays/saved/{replayId}

Adds a replay to the website's saved replays with an optional name, or removes it when isSaved is false.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.
replayIdrequired	string	ID of the session replay.

Request body

Name	Type	Description
isSavedrequired	boolean	Whether the replay has been saved.
name	string	Display name of the resource.

Example request

{
  "isSaved": true,
  "name": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
okrequired	boolean	Whether the operation succeeded.

200 example

{
  "ok": true
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/websites/{websiteId}/replays/saved/{replayId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "isSaved": true,
  "name": "string"
}'

PreviousCheck whether a replay is saved NextList visitor sessions