Request a Migration by HelpCenter.io
helpcenter_request_migrationFile a migration request: HelpCenter.io moves one or more knowledge bases (up to 50) into HelpCenter.io for the user, within 24 hours. Needs no agent_key and no account.
Use it when a knowledge base is too big to fill yourself (more than 500 articles), when helpcenter_create_help_center answers limit_reached or capacity_reached, when helpcenter_scan_import cannot read the source, or when the user has several knowledge bases to move. A public Zendesk, Intercom, Document360, Help Scout, Front or HelpDocs help center is migrated automatically; anything else goes to HelpCenter.io's migration team (status with_our_team).
Each source becomes one help center. To fill a help center you already created, put its api_key in that source's agent_key; omit agent_key to have a new one created. If you already wrote articles from a source into its help center, give each one the external_id of its address at the source: the migration replaces those in place and keeps every other article you wrote.
While the request is open, writes with those help centers' agent keys are refused (migration_in_progress); reads still work, and their 7-day deletion clock is paused.
Ask the user first: this sends their email address to HelpCenter.io's migration team. Nothing is emailed to the user automatically, not even when the migration is done.
Returns, shown only here (also as structuredContent): request_id and status_token — keep both for helpcenter_get_migration_request, and never show the token to the user; handoff_url — ONE claim link for all of the request's help centers, to give the user; help_centers [{site_id, subdomain}]; expected_by.
Limited to 30 requests a day across every agent using this connector.
Args:
email (string, required): the user's email address, asked of the user.
sources (array, required): 1 to 50 of { url, name?, article_count?, note?, agent_key? }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | The user's email address, for HelpCenter.io's migration team only: a person on the team may write to it about the migration. Nothing is sent to it automatically. Ask the user for it; never guess one. | ||
| sources | Yes | The knowledge bases to migrate, 1 to 50, one help center each. |