Members

Offer a site to another workspace

Offers the site to someone by email. They have 14 days to accept, and they pick which of their workspaces receives it (acceptTransfer). The site stays here until they do. A new offer replaces any pending one for the same site. Needs the site Owner role.

post/api/v1/sites/{slug}/transfer

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/transfer
  • Auth: HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Request body

toEmailstring email required

Who the site is offered to.

keepCollaboratorsboolean required

True to keep the site's collaborators and pending invites after the move. False clears them.

Example request

{
  "toEmail": "grace@example.com"
}

Response

The offer was created.

idstring required

The transfer's id. Use it to cancel the offer.

transferPathstring required

Dashboard path the recipient opens to review the offer.

toEmailstring required

Lowercased.

emailSentboolean required

True when an email was sent. False when email is not configured on this server, so share transferPath yourself.

Example response

{
  "transferPath": "/transfer/Xk3m9Qz"
}

Changes

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