Websites

Transfer website ownership

POST/api/websites/{websiteId}/transfer

Transfers the specified website to another user or team after checking permission for the destination.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.

Request body

Name	Type	Description
teamId	string	ID of the associated team.
userId	string	ID of the associated user.

Example request

{
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
createdByrequired	string	ID of the user who created the resource.
deletedAtrequired	string	Date and time the record was deleted, if applicable.
domainrequired	string	Domain name associated with the resource.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
recorderEnabledrequired	boolean	Whether recording is enabled for the website.
replayConfigrequired	anyOf	Session replay and heatmap recording configuration.

resetAtrequired	string	Date and time the website analytics were last reset.
teamIdrequired	string	ID of the associated team.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "createdBy": "string",
  "deletedAt": "2024-01-15T09:30:00Z",
  "domain": "string",
  "id": "string",
  "name": "string",
  "recorderEnabled": true,
  "replayConfig": "string",
  "resetAt": "2024-01-15T09:30:00Z",
  "teamId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

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}/transfer' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}'

PreviousCreate a share for a website NextList website filter values