Import and export articles
Partly availableBring articles in from another help center through the REST API, or copy them out, since there is no file import or export button yet.
On this page
There is no button to import articles from a spreadsheet or another help center product, and none to download them as a file. Both can be done through the helpdesk's REST API, which a developer, or a tool you already use with the API, can call. For a handful of articles, copying and pasting into the editor is quicker.
Copy a few articles by hand#
Open the article on your old help center and select its text, headings and lists.
In the new article, paste it into the body. Styling from the old site is removed and the structure is kept: headings, bold, links, lists and quotes.
Check images: pictures pasted from another site still point at that site. Download them and insert them again with the image button, so they are stored in your helpdesk and survive the old site closing.
Set the category and excerpt, then publish.
Import many articles with the API#
You need an API key, made by an admin in Settings > REST API; see The REST API and API keys. The help center's id is in its settings address.
Create the categories with
POST /api/help-centers/{id}/categories, giving each aname.For each article, send
POST /api/help-centers/{id}/articleswith:
| Field | What to send |
|---|---|
title | The article's title |
body_html | The article in HTML. Scripts, styles and unsafe links are removed when it is saved. |
category_id | The category from step 1, or null |
excerpt | Optional summary for lists and search results |
language | en, fr, de or es; the help center's default language when left out |
publish | true to publish at once; otherwise it stays a draft |
To add another language to an article, send
PUT /api/help-centers/{id}/articles/{articleId}with the same fields and the otherlanguage.
Images in the HTML that point at your old help center keep loading from there until that site goes away. Upload important ones again in the editor.
Moving from Gorgias or Zendesk: the importers on Settings > Imports copy tickets, customers, tags and macros, but not help center articles. Use the API or copy them by hand. See Move from Gorgias.
Export articles#
GET /api/help-centers/{id}/articles lists the articles with their titles, excerpts and HTML in each language, and accepts language, category_id, state and search to narrow the list. GET /api/help-centers/{id}/categories lists the categories in order.
The owner's full data export holds tickets, customers, macros, rules and the help center's statistics, but not the articles themselves; read them through the API.
Related articles
- The REST API and API keysFind your API address, create and revoke keys, and connect your own scripts and tools to the helpdesk, including tools written for Gorgias.
- Write and organize articlesWrite help center articles, group them in categories, keep edits as drafts until you publish, translate them, and link them in replies.
- Move from GorgiasCopy customers, tickets, tags, macros, views and rules from a Gorgias account with an API key, then switch your email and scripts over.
- Export your dataDownload a full copy of a helpdesk's data as an owner, or CSV files from reports, macros and the logs, and what to do when you need ticket-level rows.
Still stuck?
Write to the Growth Dept team and a person answers. Say which helpdesk you work in and what you were trying to do.