Archive team REST API

POST

/api/user/teams/{id}/archive

curl --request POST \
  --url https://app.hitkeep.com/api/user/teams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/archive \
  --cookie hk_token=<hk_token>

Archives a non-default team after all sites have been transferred or removed.

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Archive team response

Media typeapplication/json

object

active_team_id

string format: uuid

recent_team_ids

Array<string>

status

string

Example^generated

{
  "active_team_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "recent_team_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "status": "example"
}

400

Cannot archive the default team or a team that still owns sites

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

403

Only owners can archive teams

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}