Articles APIs

Articles are documents containing text, images, and videos that provide information to your users. Articles are categorized using categories, subcategories, and labels. There are three types of articles: (regular) articles, feature requests, and known issues. Users can follow articles and vote for feature requests. Agents can add notes and tasks to articles, such as "review", and assign them to other agents.

You can use the Articles API to manage your articles (including feature requests, known issues, and videos).
Importing Records
Contact Wix Answers to enable administrators to import articles in bulk.
An article starts as a draft until you publish it. The draft and all previously published drafts are the article versions. When you publish a draft, Wix Answers marks the draft version as published, makes the version visible in the Help Center, and automatically creates a new draft.

In the Wix Answers App, the option to publish the draft appears only when there is a difference between the draft and the most recently published version.

Additional article features include
  • Categories: You assign each article to a category, in order to assist users navigating to the articles.
  • Phrases: Add keywords to an article to assist users searching for content.
  • Related articles: Add article relations to enable users to navigate to additional relevant content.
  • User interaction: Users can follow an article, indicate if they find the article helpful, or vote on a feature request.
  • Labels: Add labels to an article to assist agents searching for and organizing articles.
  • Notes: Add notes to add comments about the entire article that are visible to other agents.
  • Comments: Add contextual comments on specific text that are visible to other agents.
  • Tasks: Add tasks to the article to indicate to specific agents that work needs to be done on the article. Tasks include requests to write additional content, update existing content, review content, or translate the article. You can add notes to the tasks.
  • Bulk management: Several methods enable you to manage articles in bulk.
Note
See Common Elements in API Payloads / Objects, including the note about undocumented parameters.
HTML Markup
After you add or import an article using the API, if you open the article in the Wix Answers editor, the editor parses your HTML into blocks (as best as it is able to) to enable you to use the editor's full suite of editing tools. When you save the article from the editor, the editor saves the contents with additional div tags, classes, and so on.

Get Article or Article Information

These methods enable you to manipulate a single article.

Get Article by ID

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}?locale={locale}&defaultLocaleFallback={true|false}
Get an article by its GUID and locale. See Finding an Article ID.
  • Authorization: None
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Article Object (public level)
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
defaultLocaleFallback
Whether to get the article associated with the default locale if no article exists for the specified locale.
Boolean. Default is false.

Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa?locale=en
Request Example Using curl:
1
curl -X GET  https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa?locale=en -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: Bearer <token>'

Get Extended Article Information

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/extended?locale={locale}

Get extended information about an article by its GUID and locale, including task information, agent information, and so forth. See Finding an Article ID.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/extended?locale=en

Get Article by URI

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/uri/{URI}?locale={locale}

Get an article by its URI and locale.
  • Authorization: None
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Article Object (public level)
Request Params
Description
Type
Required
brandId
Brand ID
Brand GUID

locale
Article language

Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/uri/machines-1?locale=en

Get Article Preview

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/preview?locale={locale}

Get an article with only its latest data by its GUID and locale. The data comes from the draft; the draft's data may or may not be different from the most recently published version's data. See Finding an Article ID.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/preview?locale=en

Get List of Article Versions

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/versions?locale={locale}

Get a list of article versions, including the draft version and all previously published versions.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/versions?locale=en

Add Article

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles

Create a new article. Also see Duplicate Articles.
Payload Params
Description
Type
Required
brandId
Brand ID
locale 
Article language
Language code string (for example: 'de')
categoryId 
Category

To add an article without a category, use  
00000000-0000-0000-0000-000000000000 as the category ID.

If a category has subcategories, you cannot associate the article with the category, only with one of its subcategories.
type
Integer
title 


The article title

The default is an empty string.
String, up to 500 characters

The default is an empty string.
content 

The article content (HTML)

See note about HTML Markup in the introduction to this article.

The default is an empty string.
String

The default is an empty string.

status 

Integer

The default is 0 (Draft).

Payload Example:
1
2
3
4
5
6
7
8
9
10
11
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles

{
  "brandId": "de3456fc-bbaa-4532-3245-eef3a0e3fa",
  "locale": "en",
  "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa",
  "type": 100,
  "status": 10,
  "title": "New App Article",
  "content": "<div>This is the article content</div>"
}
Request Example Using curl:
1
curl -X POST  https://<tenant_subdomain>.wixanswers.com/api/v1/articles  -H 'Authorization: Bearer <token>' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json' -d '{"brandId": "de3456fc-bbaa-4532-3245-eef3a0e3fa", "locale": "en", "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "type": 100, "status": 10, "title": "New App Article", "content": "<div>This is the article content</div>"}

Publish or Unpublish an Article

Publish or unpublish a single article.

Publish Article

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/publish

Optionally update an article's title and content, and then publish the article. See Important Information about Updating Using the API. To just update the article, see Update Article Title and/or Content.



The payload parameters are the same as those for Update Article Title and/or Content.
Request Example Using curl:
1
2
3
4
5
6
curl -X POST  https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/publish  -H 'Authorization: Bearer <token>' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json' -d '{
  "title": "Wix Answers - Articles APIs",
  "content": "<div>This is the article content</div>",
  "locale": "en",
  "notify": false
}

Unpublish Article

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/unpublish

Unpublish a published article. Also see Unpublish Articles in Bulk.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/unpublish

{
  "locale": "en"
}

Delete or Restore an Article

Delete or restore a single article.

Delete Article

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}?locale={locale}

Delete a single article. The article can be restored (see Restore Deleted Article). Also see Delete Articles in Bulk and see Delete All Articles in a Category.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa?locale=en

Restore Deleted Article

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/restore

Restore a previously deleted article. Note that the ID of the article to restore is in the path.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/restore

{
  "locale": "en"
}

Merge Articles

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/merge

Merge this article (the article whose GUID appears in the path) into another one. This article is removed. All followers and notes move to the target article.

Note: You cannot merge an article into another article that is associated with a different brand.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
targetId
The article into which to merge this article
updateCategories
Whether to move the target article to be under the category of this article.
Boolean. Default is false.

Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/merge

{
  "locale": "en",
  "targetId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa"
}

Update Article or Article Metadata

These methods enable you to update metadata associated with an article.

Update Article Title and/or Content

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}

Update an article's title and content. See Important Information about Updating Using the API. Also see Publish Article.
Payload Params
Description
Type
Required
locale 

Article language
Language code string (for example: 'de')
title
The article title

To not change the title, send the existing title. Otherwise, the title is changed to a blank string.
String, up to 500 characters

Note that, although this endpoint does not fail if the title has more than 500 characters, you cannot publish an article that has a title with more than 500 characters.

content
The article content (HTML)

To not change the content, send the existing content. Otherwise, the content is changed to a blank string.

See note about HTML Markup in the introduction to this article.
String

updateUrl



If you updated the title, Wix Answers updates the article URI to match the new title. Any requests to the old URI are redirected to the new one.

Set this to false to keep the old URI.
Boolean

Default is true.

notify


Whether to notify users who follow the article that the article was updated.
Boolean

Default is false.

Payload Example:
1
2
3
4
5
6
7
8
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa

{
  "title": "Wix Answers - Articles APIs",
  "content": "<div>This is the article content</div>",
  "locale": "en",
  "notify": false
}

Update Article Category

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/move

Move an article to a different category. Also see Move Articles in Bulk and  Move All Articles from One Category to Another.

If a category has subcategories, you cannot move an article to the category, only to one of its subcategories.
Payload Params
Description
Type
Required
newCategoryId
New category

To remove the category, use 00000000-0000-0000-0000-000000000000 as the category ID.

Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/move

{
  "newCategoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa"
}

Update Article Type

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/changeType

Change an article type, and optionally its resolution (for the recommended way to change the resolution, see Update Article Resolution).
Payload Params
Description
Type
Required
type
Integer
resolution
Integer

Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/changeType

{
  "type": 110
}

Update Article Resolution

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/setResolution

Change an article resolution.
Payload Params
Description
Type
Required
resolution
Integer
locales
List of articles language to set the resolution
List of language code strings (for example: ['de','en'])
At least one is required
notify
Whether to notify article followers about the change in resolution
Boolean

Default is true.

Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/setResolution

{
  "resolution": 124,
  "locales": ["en"]
}

Update Article Phrases

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/phrases

Change an article's phrases. These are keywords that are used for when searching for articles (see Search for Articles (Agent)). See Important Information about Updating Using the API.
Note
Currently, phrases do not appear, and cannot be managed, in the Help Center or the Wix Answers App. However, if phrases are attached to articles, they are used when searching in the Help Center or using the API.
Payload Params
Description
Type
Required
locale
Article language
Language code string (for example: 'de')
textValues
List of phrases
List of strings
Payload Example:
1
2
3
4
5
6
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/phrases

{
    "locale": "en",
    "textValues": ["programming", "JavaScript"]
}

Update Article Labels

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/labels

Add or remove labels from an article. Also see Manage Article Labels in Bulk.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
addedLabelIds
List of labels to add to article
List of GUIDs

removedLabelIds

List of labels to remove from article

Note that if the same label appears in both the "add" and "remove" lists, it will remain in the article (labels are first removed, and then added).
List of GUIDs

Payload Example:
1
2
3
4
5
6
7
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/labels

{
  "locale": "en",
  "addedLabelIds": ["bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa","bd948e62-a3fd-ee6a-4cf0-87f30ae7f3fb"],
  "removedLabelIds": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fc"]
}
These methods enable you to update related articles associated with an article.

Add Article Relation

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations

Add an article relation. The related article must be published.
Payload Params
Description
Type
Required
locale 
Article language for which to add the new relations

If not sent, the related articles are added to the article in all locales.
Language code string (for example: 'de')

relatedId

The published article to relate to this one
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/relations

{
  "locale": "en",
  "relatedId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa"
}
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations?locale={locale}

Get related articles for this article. See also Get an Article's Related Articles (Agent).
  • Authorization: None
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: List of Article Objects (public level)
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/relations?locale=en
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations/admin?locale={locale}

Get related articles for this article, including task information, agent information, and so forth.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/relations/admin?locale=en

Delete Article Relation

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations/{related article GUID}

Delete an article relation.
Request Params
Description
Type
locale 
Article language for which to remove the related articles

If not sent, the related articles are removed from the article in all locales.
Language code string (for example: 'de')
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/relations/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fb
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations/sort

For this article, sort list of related articles by their title, ascending. Related articles are normally sorted according to the order they were added.
Payload Params
Description
Type
Required
locale
Article language
Language code string (for example: 'de')
relatedIds
Related articles to sort
List of GUIDs
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/relations/sort

{
  "relatedIds": ["bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa", "bd948e62-a3fd-ee6a-4cf0-87f30ae7f3fb"],
  "locale": "en"
}

Manage Article Notes

These methods enable you to update notes associated with an article.

Add Article Note

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes

Add article note.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
content
The note content
String
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/notes

{
    "locale": "en",
    "content": "A note."
}

Get Article Note

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes/{note GUID}?locale={locale}

Get article note by ID.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fb?locale=en

Get All Article Notes

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes?locale={locale}
Get all notes of an article.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes?locale=en

Update Article Note

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes/{note GUID}

Update article note. See Important Information about Updating Using the API.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
content
The note content
String
Payload Example:
1
2
3
4
5
6
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a

{
    "locale": "en",
    "content": "A new note."
}

Delete Article Note

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes/{note GUID}?locale={locale}

Delete article note.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb?locale=en

Manage Article Comments

These methods enable you to manage contextual comments associated with specific content in the article, as well as replies to these comments.  Article comments are visible to other agents.

Add Article Comment

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments
Add article comment.

After adding an article comment, you must use the returned comment GUID to add a tag in the article that references this comment. The tag must surround the article content that you want to mark up with the comment. Add the following tag to the article, replacing {comment GUID} with the comment GUID.
1
2
3
 ...
<span data-composite="true" data-comment-id="{comment GUID}">tagged content</span>
...

If you do not add the tag to the article, the comment exists but does not appear in the article in the KB.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
content
The article comment text
String

The max length is 2,000 characters.
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments

{
    "locale": "en",
    "content": "A new comment."
}

Get Article Comments

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments?locale={locale}
Get all comments of an article.
Article Comment Tags
An article comment object does not indicate where the comment appears in the article. To locate an article comment in an article, search the article content for the tag <span data-composite="true" data-comment-id="{comment GUID}">...</span>.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments?locale=en

Update Article Comment

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments/{comment GUID}

Update article comment. See also Mark Article Comment as Resolved or Not Resolved.
Request Params
Description
Type
Required
content
The article comment text
String

The max length is 2,000 characters.
Payload Example:
1
2
3
4
5
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments/d367738e-368e-41fe-9289-1a5cbbc3c239

{
    "content": "A new comment."
}

Delete Article Comment

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments/{comment GUID}

Delete article comment.
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb

Mark Article Comment as Resolved or Not Resolved

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments/{comment GUID}/resolved

Resolve or reopen an article comment, i.e. mark an article comment as resolved or unresolved.
Request Params
Description
Type
Required
resolved
Whether the article comment is resolved (true) or not resolved (false)
Boolean
Payload Example:
1
2
3
4
5
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments/d367738e-368e-41fe-9289-1a5cbbc3c239/resolved

{
    "resolved": true
}

Add Article Comment Reply

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments/{comment GUID}/replies

Add article comment reply.
Request Params
Description
Type
Required
content
The reply text
String

The max length is 2,000 characters.
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments/d367738e-368e-41fe-9289-1a5cbbc3c239/replies

{
    "content": "A new reply."
}

Get Article Comment Replies

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments/{comment GUID}/replies

Get article comment replies.
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments/d367738e-368e-41fe-9289-1a5cbbc3c239/replies

Update Article Comment Reply

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments/{comment GUID}/replies/{reply GUID}

Update article comment reply.
Request Params
Description
Type
Required
content
The reply text
String

The max length is 2,000 characters.
Payload Example:
1
2
3
4
5
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments/d367738e-368e-41fe-9289-1a5cbbc3c239/replies/77bc8694-5ccf-436c-ab2b-543563a5f425

{
    "content": "An updated new reply."
}

Delete Article Comment Reply

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/comments/{comment GUID}/replies/{reply GUID}

Delete article comment reply.
Payload Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/comments/d367738e-368e-41fe-9289-1a5cbbc3c239/replies/77bc8694-5ccf-436c-ab2b-543563a5f425

Manage Article Tasks

These methods enable you to update tasks associated with an article, as well notes associated with these tasks.

Add Article Task

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks

Add article task. Also see Add Article Tasks in Bulk.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
type
Integer
priority
Integer
assignedGroupId
Agent group to which to assign this task
Either this or assignedUserId is required.
assignedUserId
Agent to which to assign this task
Either this or assignedGroupId is required.
description
Task description
String

Payload Example:
1
2
3
4
5
6
7
8
9
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/tasks

{
    "locale": "en",
    "type": 30,
    "priority": 20,
    "assignedUserId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa",
    "description": "Please review!"
}

Get Article Task Information

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}

Get information about an article task.
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-ee6a-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb

Get All Article Tasks

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks?locale={locale}

Get information about all article tasks.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
page
The page of results to return

If not specified, the default is 1.
Integer

pageSize
The number of results to return on each page

If not specified, the default is 20.
Integer

Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/tasks?locale=en
Response Example:
1
2
3
4
5
6
7
8
9
{
  "items": [ List of @ContentTask objects ],
  "itemsCount": 108,
  "page": 2,
  "numPages": 22,
  "previousPage": 1,
  "nextPage": 3,
  "pageSize": 5
}

Get a Count of an Article's Tasks

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/count

Get the number of tasks attached to an article. You can filter by task status.
  • Authorization: Requires agent authorization token and permission FETCH_ARTICLES
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Integer
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
status
Integer

Add Article Translations

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/translations

Add article translations and, by default, translation tasks for these translations. After creating a translation task, Wix Answer invokes the Article Sent to Translation webhook. Also see Add Article Translations in Bulk.
Payload Params
Description
Type
Required
locales
List of required Article languages
List of language code strings (for example: ['de','en'])
At least one is required
taskPriority
Integer

Default is 20.

openTranslationTasks
Whether to add translation tasks for the article translations
Boolean

Default is true.

noteText
Note contents
String

Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/translations

{
  "locales": ["de"]
}

Update Article Task

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}

Update article task. See Important Information about Updating Using the API. To mark a task as complete / open, see Complete Article Task or Open/Reopen Article Task.
Payload Params
Description
Type
Required
priority
Integer
assignedGroupId
Agent group to which to assign this task
Either this or assignedUserId is required.
assignedUserId
Agent to which to assign this task
Either this or assignedGroupId is required.
description
Task description
String

Payload Example:
1
2
3
4
5
6
7
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/tasks/d367738e-368e-41fe-9289-1a5cbbc3c239

{
    "priority": 20,
    "assignedUserId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa",
    "description": "Please review!"
}

Complete Article Task

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/complete

Complete an article task. This updates the status, completion date, and "completed by user" fields of the task.

No payload is required.

Open/Reopen Article Task

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/open

Open or reopen an article task. This updates the task's status. If the article was previously marked as complete, this does not change the completion date or "completed by user" fields of the task.

No payload is required.

Add Article Task Note

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/notes

Add note about article task.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')

content
The note content
String
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/tasks/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/notes

{
    "locale": "en",
    "content": "I will review."
}

Update Article Task Note

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/notes/{note GUID}

Update note about article task. See Important Information about Updating Using the API.
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
content
The note content
String
Payload Example:
1
2
3
4
5
6
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/tasks/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/d367738e-368e-41fe-9289-1a5cbbc3c239

{
    "locale": "en",
    "content": "I will review."
}

Delete Article Task Note

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/notes/{note GUID}?locale={locale}

Delete note about article task.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-ee6a-87f30ae7f3fb/notes/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fc?locale=en

Delete an Article Task

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}?locale={locale}

Delete an article task. To delete multiple tasks, see Delete One or More Article Tasks.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb?locale=en

Delete One or More Article Tasks

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks?locale={locale}&ids={task GUID},{task GUID},...

Delete one or more tasks from an article.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
ids
Tasks to delete, separated by commas

Alternately, include this param for each task to delete.
List of GUIDs
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-ee6a-87f30ae7f3fb?locale=en&ids=bd948e62-a3fd-4cf0-87f30ae7f3fc,bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fd

Manage Article Interaction (Follow, Helpful, Vote)

These methods enable you to update user interaction associated with an article, including followers, votes for feature requests, and users who marked an article or video as helpful (or otherwise).

Get Counters of Article Interactions

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/counters?locale={locale}

Get a list of counts of article followers, views, voters, and helpful/unhelpful indications.
  • Authorization: Requires agent authorization token
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: List of Counter objects, one of each counter type
Request Params
Description
Type
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/counters?locale=en

Get Whether You Follow an Article

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/follow?locale={locale}

Get whether you are following an article.
  • Authorization: Requires agent authorization token for specific user
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Boolean
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/follow?locale=en

Get List of Articles You Follow

GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/followed?locale={locale}

Get the list of articles that you follow.
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
page
Page of results
Integer

Default is 1.

pageSize
Number of results on each page
Integer, between 1 and 500

Default is 10.

Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/followed?locale=en&page=2&pageSize=20
Response Example:
1
2
3
4
5
6
7
8
9
{
  "items": [ List of @Article objects ],
  "itemsCount": 108,
  "page": 2,
  "numPages": 22,
  "previousPage": 1,
  "nextPage": 3,
  "pageSize": 5
}

Follow an Article

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/follow

Follow an article.
  • Authorization: Requires agent authorization token for specific user
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/follow

{
    "locale": "en"
}

Unfollow an Article

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/follow?locale={locale}

Unfollow an article.
  • Authorization: Requires agent authorization token for specific user
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/follow?locale=en

Indicate If You Find an Article or Video Helpful

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/helpful

Mark or clear an article or video as helpful or not helpful.
  • Authorization: None
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
newState
New helpful indication:
* Not helpful (-1)
* No indication (0)
* Helpful (1)
-1, 0, or 1
state
Previous helpful indication:
* Not helpful (-1)
* No indication (0)
* Helpful (1)
-1, 0, 1

Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/helpful

{
    "locale": "en",
    "newState": 1
}

Vote for a Feature Request

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/vote

Vote for a feature request article. If you have already voted for this request, this has no effect.
  • Authorization: None
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/vote

{
    "locale": "en"
}

Clear Your Vote from a Feature Request

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/vote?locale={locale}

Clear your vote from a feature request article. If you have not already voted for this request, this has no effect.
  • Authorization: None
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Request Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/vote?locale=en

Manage Multiple Articles

These methods enable you to work with articles in bulk.

Search for Articles (Agent)

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/search/admin

Get list of articles matching search / filter criteria.
Note:
The search include drafts and deleted articles.  The returned articles include extended information, including associated labels.
Payload Params
Description
Type
Required
brandId
Filter by brand
Brand GUID

ids
Search for specific articles
List of GUIDs

excludedIds
Filter by excluding specific articles
List of GUIDs

permalink
Search for article at specific URI
String

locale
Filter by article language
Language code string (for example: 'de')
statuses
Filter by list of Article Statuses

Draft (0) is the default.
List of integers

resolutions
Filter by list of Article Resolutions
List of integers

handledByuserIds
Filter by list of agents that have handled (created or edited) the article.
List of GUIDs

handledByMe
Filter by articles that you have handled
Boolean

types
Filter by list of Article Types
List of integers

categoryIds
Filter by list of included categories/subcategories
List of GUIDs

excludedCategoryIds
Filter by list of excluded categories/subcategories
List of GUIDs

searchParentCategories
Whether to also include / exclude parent categories for the categories listed in categoryIds / excludedCategoryIds
Boolean

Default is true.

text
For a text search (sortType=100), filter by best match for exact text in the article title, content (see searchContent.), or phrases
String

Max 200 characters.

mustMatchText
For a text search (sortType=100), filter by exact text that must appear in the article title, content, or phrases.
String

mustNotMatchText
For a text search (sortType=100), filter by exact text that must not appear in the article title, content, or phrases.
String

searchContent
Whether to also apply a text search (text, mustMatchText, mustNotMatchText) to the article content (and not only the title or phrases)
Boolean

Default is true.

spellcheck
Whether to correct the spelling in the text search string and try the search again if searching with the uncorrected search string yielded no results.
Boolean

Default is true.

analyzeText
When true, then if text is not empty, and mustMatchText and mustNotMatchText are empty, then parse the text search string, as follows:
- Words that starts with a dash "-" are added to a "must not match" list.
- Words that starts with a dash "+" are added to a "must match" list.
- All other words are used to search as regular text.

When false, the text field is used to search as regular text.
Boolean

Default is true.

multilingual
Filter by whether the article is multilingual (has multiple versions for different languages)
Boolean

taskType
Filter by list of Content Task Types associated with the article
List of integers

taskStatuses
Filter by list of Content Task Statuses associated with the article
List of integers

taskPriorities
Filter by list of Content Task Priorities of tasks associated with the article
List of integers

taskCreatedByUserIds
Filter by list of agents who created tasks associated with the article
List of GUIDs

taskAssignedUsedIds
Filter by list of agents assigned to tasks associated with the article
List of GUIDs

taskAssignedGroupIds
Filter by list of agent groups assigned to tasks associated with the article
List of GUIDs

taskExcludedAssignedUserIds
Filter by list of agents not assigned to tasks associated with the article
List of GUIDs

taskCompletedByUserIds
filter by list of agents who completed tasks associated with the article
List of GUIDs

unassignedTasks
Whether to return only articles with unassigned tasks

false means don't consider whether or not there are unassigned tasks associated with the article.
Boolean

Default is false.

summarize
Limit the returned article content to 200 characters, each.
Boolean

Default is false.

hasAllOfLabelIds 
Filter by articles that include all of a list of included labels
List of GUIDs

hasAnyOfLabelIds
Filter by articles that include any of a list of included labels
List of GUIDs

notHasAnyOfLabelIds
Filter by articles that do not include any of a list of included labels
List of GUIDs

fromCreationDate
Filter by articles first created after this time
Unix time string

toCreationDate
Filter by articles first created before this time
Unix time string

fromLastUpdateDate
Filter by articles last updated after this time
Unix time string

toLastUpdateDate
Filter by articles last updated before this time
Unix time string

fromFirstPublishDate
Filter by articles first published after this time.
Unix time string

toFirstPublishDate
Filter by articles first published before this time.
Unix time string

fromLastPublishDate
Filter by articles last published after this time.
Unix time string

toLastPublishDate
Filter by articles last published before this time.
Unix time string

page
The page of results to get
Integer, 1 or greater

Default is 1.

pageSize
The number of results on each page
Integer. between 1 and 500

Default is 10.

sortType
Sort type. Possible values:
* Creation date, ascending (10)
* Creation date, descending (20)
* Last updated date, ascending (30)
* Last updated date, descending (40)
* Position (50): The article's current sort order
* Related tickets count, ascending (60)
* Related tickets count, descending (70)
* Best match (text search) (100). When using this sort type, enter a text string in text.
* First published date, ascending (110)
* First published date, descending (120)
* Last published date, ascending (130)
* Last published date, descending (140)
* Content last updated, ascending (150)
* Content last updated, descending (160)
Integer

Payload Example:
1
2
3
4
5
6
7
8
9
10
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/search/admin

{
  "text": "search article",
  "locale": "en",
  "spellcheck": true,
  "page": 1,
  "pageSize": 5,
  "sortType": 100
}
Response Example:
1
2
3
4
5
6
7
8
9
{
  "items": [ List of @Article objects ],
  "itemsCount": 108,
  "page": 2,
  "numPages": 22,
  "previousPage": 1,
  "nextPage": 3,
  "pageSize": 5
}

Search for Articles (User)

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/search

Get list of articles matching search / filter criteria.

Any content scope settings defined for the Help Center are merged with the search criteria sent in the request.

  • Authorization: None
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Structure including list of Article Objects (public level)

The payload params and return structure are the same as those for the agent search; see Search for Articles (Agent).

Search for Articles by Ticket

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/ticketsRelatedSearch

Get list of articles associated to a list of tickets.


The payload and return structure is the same as for the regular agent search; see Search for Articles (Agent).

Get the Number of Articles in a Category

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/category/count/admin

Get the number of articles in a category. If the category has subcategories, this gets the number of articles in all of its subcategories. Includes draft-only articles (articles with no published versions), but does not include deleted articles.
  • Authorization: Requires agent authorization token and permission FETCH_ARTICLES
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Result structure, see below
Payload Params
Description
Type
Required
locale
Article language
Language code string (for example: 'de')
categoryId
Category
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/category/count/admin

{
    "locale": "en",
    "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa"
}
Response Example:

Map of category IDs to category article count structure, for example:
1
2
3
4
{
    {"bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa", {"draftCount": 1, "publishedCount": 24} },
    {"bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb", {"draftCount": 0, "publishedCount": 5} }
}

Manage Article Labels in Bulk

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/labels

Add or remove labels from one or more articles. To manage the labels of one article, see Update Article Labels.

Payload Params
Description
Type
Required
locale 
Article language
Language code string (for example: 'de')
ids
List of articles for which to change labels 
List of GUIDs

The maximum number is 50.
addedLabelIds
List of labels to add to article
List of GUIDs

removedLabelIds

List of labels to remove from article

Note that if the same label appears in both the "add" and "remove" lists, it will remain in the article (labels are first removed, and then added).
List of GUIDs

Payload Example:
1
2
3
4
5
6
7
8
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/labels

{
  "locale": "en",
  "ids": ["44e48e62-ee6a-a3fd-4cf0-87f30ae7f3fa","5356deca-a3fd-ee6a-4cf0-87f30ae7f3fb"],
  "addedLabelIds": ["bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa","bd948e62-a3fd-ee6a-4cf0-87f30ae7f3fb"],
  "removedLabelIds": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fc"]
}

Add Article Tasks in Bulk

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/tasks

Add the same article task to one or more articles. To add an article task to one article, see Add Article Task.
  • Authorization: Requires agent authorization token and permission CREATE_ARTICLES
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Return structure, see below
Payload Params
Description
Type
Required
itemIds
The articles to which to add the tasks
List of GUIDs
locale 
Article language
Language code string (for example: 'de')
type
Integer
priority
Integer
assignedGroupId
Agent group to which to assign these tasks
Either this or assignedUserId is required.
assignedUserId
Agent to which to assign these tasks
Either this or assignedGroupId is required.
description
Task description
String

Payload Example:
1
2
3
4
5
6
7
8
9
10
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/tasks

{
    "itemIds": ["ee948e62-eefd-4cf0-87f3-ee6a0ae7f3ff", "77bc8694-5ccf-436c-ab2b-543563a5f425"],
    "locale": "en",
    "type": 30,
    "priority": 20,
    "assignedUserId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa",
    "description": "Please review!"
}
Response Example:
Response Params
Description
Type
contentTasks
The list of successfully processed tasks
failedContentTaskItemsErrors
Map with pairs of tasks that could not be processed to their error codes, as follows:

* Task GUID
Integer
1
2
3
4
5
6
7
{
    "contentTasks": [ @Content Task object, @Content Task object, ...],
    "failedContentTaskItemsErrors": {
      "d367738e-368e-41fe-9289-1a5cbbc3c239",
      {"errorCode": "-50006", "message": "NOT_FOUND"}
    }
}

Add Article Translations in Bulk

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/translations

Add one or more article translations and, by default, translation tasks for these translations. After creating a translation task, Wix Answer invokes the Article Sent to Translation webhook. To add translations for only one article, see Add Article Translations.
Payload Params
Description
Type
Required
ids
List of articles to translate
List of GUIDs

The maximum number is 50.
At least 1 ID is required.
locales
List of required Article languages
List of language code strings (for example: ['de','en'])
At least one is required
taskPriority
Integer

Default is 20.

openTranslationTasks
Whether to add translation tasks for the article translations
Boolean

Default is true.

noteText
Note contents
String

Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/translations

{
  "locales": ["de"],
  "ids": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb", "77bc8694-5ccf-436c-ab2b-543563a5f425"]
}

Publish Articles in Bulk

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/publish

Unpublish one or more articles. To unpublish only one article, see Publish Article.

Payload Params
Description
Type
Required
ids
List of articles to publish
List of GUIDs

The maximum number is 50.
At least 1 ID is required.
locale
Language of articles
Language code string (for example: 'de')
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/publish

{
  "locale": "en",
  "ids": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb", "77bc8694-5ccf-436c-ab2b-543563a5f425"]
}

Unpublish Articles in Bulk

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/unpublish

Unpublish one or more articles. To unpublish only one article, see Unpublish Article.

Payload Params
Description
Type
Required
ids
List of articles to unpublish
List of GUIDs

The maximum number is 50.
At least 1 ID is required.
locale
Language of articles
Language code string (for example: 'de')
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/unpublish

{
  "locale": "en",
  "ids": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb", "77bc8694-5ccf-436c-ab2b-543563a5f425"]
}

Move Articles in Bulk

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/move

Move one or more articles. To move only one article, see Update Article Category.

If a category has subcategories, you cannot associate articles with the category, only with one of its  subcategories.
Payload Params
Description
Type
Required
ids
List of articles to move
List of GUIDs

The maximum number is 50.
At least 1 ID is required.
categoryId
New category

To remove the category, use  
00000000-0000-0000-0000-000000000000 as the new category ID.
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/move

{
  "categoryId": "bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa",
  "ids": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb", "77bc8694-5ccf-436c-ab2b-543563a5f425"]
}

Move All Articles from One Category to Another

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/move/byCategory

Move all articles from one category to another category. To move only one article, see Update Article Category.

If a category has subcategories, you cannot associate articles with the category, only with one of its  subcategories.
Payload Params
Description
Type
Required
categoryId
Current category
newCategoryId
New category

To remove the category, use  
00000000-0000-0000-0000-000000000000 as the new category ID.
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/move/byCategory

{
  "categoryId": "bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa",
  "newCategoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb"
}

Duplicate Articles

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/duplicate

Create copies of one or more articles.

Payload Params
Description
Type
Required
targetBrandId
Target brand for new articles
Brand GUID
locale
Language of articles
Language code string (for example: 'de')
sourceArticleIds
List of articles to duplicate
List of article GUIDs
targetCategoryId
Target category for new articles
Category GUID
includeArticleTranslation
Whether to also duplicate the article translations
Boolean

copyAttributes
Whether to also copy all article attributes
Boolean

titleSuffix
String to add to the title of each duplicate
String

The default is the empty string ("").

Note that this endpoint fails to duplicate an article if the new title of the article will be more than 500 characters.

Payload Example:
1
2
3
4
5
6
7
8
9
10
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/duplicate

{
  "sourceArticleIds": ["eff48e62-a3fd-4cf0-87f3-ee6a0ae7f3fa","bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa"],
  "locale": "en",
  "targetCategoryId": "77bc8694-5ccf-436c-ab2b-543563a5f425",
  "includeArticleTranslation": true,
  "copyAttributes": true,
  "titleSuffix": " - Copy"
}

Sort Articles in a Category

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/sort

Sort all articles in a category according to the specified order. Before this is run, articles are sorted according to the order they were added.
Payload Params
Description
Type
Required
locale
Article language
Language code string (for example: 'de')
categoryId
Category to sort
id
List of articles in the desired sort order

If you include any articles that are not associated with the category, the operation fails. If you do not include one or more articles that are are associated with the category, the ones that you include are sorted in the specified order and appear before the other (not included) articles.
List of GUIDs
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/sort

{
  "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa",
  "locale": "en"
}

Delete Articles in Bulk

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/delete

Delete one or more articles. To delete one article, also see Delete Article. To restore an article, see Restore Deleted Article.
Payload Params
Description
Type
Required
ids
List of articles to delete
List of article GUIDs

The maximum number to delete is 50.
locale
Language of articles
Language code string (for example: 'de')
Payload Example:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/delete

{
  "ids": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "d367738e-368e-41fe-9289-1a5cbbc3c239"]
  "locale": "en"
}

Delete All Articles in a Category

POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/deleteByCategory

Delete all articles in a category. If the category has subcategories, the operation fails. To delete one article, see Delete Article. To restore an article, see Restore Deleted Article.
  • Authorization: Requires agent authorization token and permission CREATE_ARTICLES
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: Result structure, see below
Payload Params
Description
Type
Required
categoryId
Category
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/deleteByCategory

{
  "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa"
}
Response Example:
Response Params
Description
Type
successCount
The number of articles deleted
Integer
failCount
The number of articles that could not be deleted
Integer
1
2
3
4
{
    "successCount": 12,
    "failCount": 0
}

Bulk Articles Response Structure

The following structure is returned, where noted, for several Article bulk processing methods.
Response Params
Description
Type
articles
The list of successfully processed articles
failedArticleErrors
Map with pairs of articles that could not be processed to their error codes, as follows:

* Article GUID
Integer
1
2
3
4
5
6
7
{
    "articles": [ @Article object, @Article object, ...],
    "failedArticleErrors": {
      "d367738e-368e-41fe-9289-1a5cbbc3c239",
      {"errorCode": "-50006", "message": "NOT_FOUND"}
    }
}
IN THIS ARTICLE

Related Articles

Deleting an Article

Delete an article to permanently remove it from your Knowledge Base, Help Center, and Widgets. Tip:Instead of deleting an article, you can unpublish it to keep it saved as a draft for future use. Warning:Deleti

1 min read

Unpublishing an Article

Unpublish an article if you want to remove its live version, but keep it saved as a draft for future use. Articles that are unpublished appear as drafts in your Knowledge Base. Need to unpublish multiple articl

1 min read

Linking Article Text to Another Article

Link text in your article to another article to guide customers to related content. This helps you keep your articles concise without excluding helpful resources. To link article text to another article:Go to t

1 min read

Publishing an Article

Publish an article when you're ready for it to go live. When you make changes to the article's content, make sure to publish again to update the live version. When you publish, you can choose to notify follower

1 min read

Creating an Article

Articles are the core of your Help Center. You can create different types of articles for different needs. The following is intended to walk you through the process of creating an Informative article. You can a

5 min read

Editing an Article

You can update an article from its Content Editor anytime you need to make changes. Tip:Add comments to specific article content for other team members to review. Learn moreLearn how to go to an article's Conte

2 min read

Finding an Article ID

An article ID (GUID) references a specific article, including all translated versions of an article. The ID is useful if you are linking from a product that is translated into many languages, and you need a way

1 min read