Transfer Site

  • REST Method: PUT
  • URL: https://docsapi.helpscout.net/v1/sites/transfer/{id}
  • Content-Type: application/json

Use this endpoint to move a Docs site from one Help Scout account to another. This can be used to consolidate sites under one account. The site will be moved from the account whose credentials are used to authenticate the request. The destination account is specified in the request body.

Request

Name Type Required Default Options Notes
TransferRequest Object Y     The body of the request (see example below).
{
    "destinationApiKey": "7417965783e9e85a3e4f5e86d76f091c36a60f08c"
}

Accepted Fields

Name Type Required Default Notes
destinationApiKey String Y The Docs API key from the account to transfer to the site to

Response

Response Name Type Notes
Header Status Integer 200
Status: 200 OK