Choose What an Import Brings
helpcenter_choose_importChoose which categories and languages an import brings, and whether articles arrive as drafts (the default) or as they are at the source. Starts nothing.
While the help center is unclaimed, a choice that would take it past its 500 articles is refused (limit_reached) with the room left: choose fewer categories, or file a migration request.
Args:
import_id (number, required)
category_ids (string[], required): ids from the import's plan.categories; each brings everything nested under it.
languages (string[], required): codes from plan.languages whose lands_in is not null.
arrive_as ('draft' | 'as_is', optional): unchanged when omitted.
Returns: { import } with the new selection.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. | |
| arrive_as | No | 'draft' (the default) brings articles in unpublished; 'as_is' keeps their published state at the source. Unchanged when omitted. | |
| import_id | Yes | The import's id, from helpcenter_scan_import or helpcenter_list_imports. | |
| languages | Yes | Language codes from the import's plan (plan.languages) whose lands_in is not null. | |
| category_ids | Yes | Category ids from the import's plan (plan.categories): each brings everything nested under it. |