Salesforce Knowledge Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Overview
SOAP API
REST API
Invocable Actions
Manage Knowledge
Archive the Primary Version of an Article
Assign a Task Related to a Primary Article
Assign a Task Related to a Translation
Delete a Primary Version of an Article
Delete a Translated Version of an Article
Edit an Online Version of a Primary Article
Get a List of Salesforce Site and Experience Cloud Site URLs for an Online Article
Publish the Primary Version of an Article
Restore an Archived Version of an Article
Retrieve Article Metadata
Get Knowledge Language Settings
Retrieve a Version of an Article
Search for Metadata Elements of a Primary Version
Search for Metadata Elements of a Translated Version
Set a Translated Article Version to Complete
Set a Translated Article Version to Incomplete
Submit an Article for Translation
Unpublish the Primary Version of an Article
Unpublish the Online Version of a Translated Article
Parameterized Search
Search
Search Scope and Order
Search Result Layouts
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Support Knowledge
Metadata API
SOQL and SOSL
Apex
UI API
PDF

Archive the Primary Version of an Article

Archives the primary version of an article. The actions are defined by the field change you request on the resource. To archive the primary version, use "publishStatus":"Archived". To schedule a date for archiving, use "archiveScheduleDate" : <date>.

Syntax

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

URI
/services/data/v25.0/knowledgeManagement/articleVersions/masterVersions/<versionID>
Formats
JSON, XML
HTTP Method
PATCH
Authentication
Authorization: OAuth accesstoken
Parameters
Parameter Description
publishStatus Publishing status of the article. Use archived.
archiveScheduleDate Date to archive the article.
Input:
Archive:
{
      "publishStatus":"Archived"
      }
Schedule for archiving (using GMT date format): 
{
       "archiveScheduleDate" : "2012-04-19T07:00:00.000+0000"
       }
Output:
HTTP status code 204 is returned when an existing record is updated.