Guest

Move a guest site onto your account

Moves the guest site behind a guest token into your own workspace as a Free site, then revokes the guest token. After this the site is an ordinary site: publish it, rename it and connect domains.

Call it with a signed-in user's OAuth access token in Authorization: Bearer …. A pga_ API key or a guest token in that header answers 401 unauthorized, because a claim belongs to a person. The guest token of the site you are claiming goes in the body. Claiming the same site again as the same user answers 200 with the same body.

Each account can claim one guest site (409 guest_claim_limit). A workspace that is already at its Free-site limit answers 403 free_site_limit.

post/api/v1/anon/claim

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/anon/claim
  • Auth: HTTP bearer

Request body

guestTokenstring required

The guestToken that POST /api/v1/anon/sites returned for the site you want to keep.

Example request

{
  "guestToken": "pgg_Zk3qR1m7vT0aXc9LwYb2NfHj5uPdE8sGiO4tAx6VnMo"
}

Response

The site is now in your workspace.

slugstring required

The claimed site's slug. It keeps its anon… slug.

status'claimed' required

Example response

{
  "slug": "anon3f9c1b27a4"
}

Changes

No recorded changes to this operation across all 1 revision of this API.