Skip to product menu
Skip to main content

Update an Article

Description

You can use this API to update an article.

Requested Payload: (Optional)

  • department_id: To map the article associated with the department.
  • title: The title of the article.
  • published: The publishing status of the article.
  • content: The HTML content available in the article.
  • category_id: You can use the existing category ID to list the article under it.
  • enabled: To specify if the article has been enabled or not.

OAuth Scope:

articles.UPDATE

URL

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screenname}/articles/{id}

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/articles/360000014486001

Payload:

Copied{
  "department_id": "17000000002003",
  "title": "Applying Promo/coupon code",
  "published": "true",
  "content": "<div>A coupon is an image with a message that you give to a user when he/she has taken part in the promotion.<br/></div>",
  "category_id": "17000000012001"
}

Success Response:

Copied{
  "url": "/api/v2/zylker-inc/articles/17000000012005",
  "object": "articles",
  "data": {
    "modified_time": "1569826933765",
    "category": {
      "name": "Zylker - Promo/Coupon",
      "id": "17000000012001"
    },
    "id": "17000000012005",
    "modifier": {
      "name": "Patricia",
      "id": "17000000007001"
    },
    "creator": {
      "name": "Patricia",
      "id": "17000000007001"
    },
    "stats": {
      "viewed": "7",
      "used": "5",
      "liked": "4",
      "disliked": "0"
    },
    "content": "<div>A coupon is an image with a message that you give to a user when he/she has taken part in the promotion events.<br/></div>",
    "enabled": true,
    "published": true,
    "department_id": "17000000002003",
    "title": "Applying Promo/Coupon code",
    "created_time": "1569826933765"
  }
}