Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
KnowledgeBaseArticle

Update KnowledgeBaseArticle

Update an existing 'KnowledgeBaseArticle' record.

patch/KnowledgeBaseArticle/{id}

Headers

X-Version-Numberstring

A version number for optimistic concurrency control. Obtained from the 'versionNumber' field.

Request body

idstring

An ID.

namestring

A one-line string.

status'Draft' | 'In Review' | 'Published' | 'Archived'
languagestring
type'Article'
portalsIdsstring[] nullable

IDs of records of the Portal type.

portalsNamesobject nullable

An {ID => record name} map.

publishDatestring date nullable

A date.

expirationDatestring date nullable

A date.

orderinteger nullable
descriptionstring nullable

A multi-line text.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

categoriesIdsstring[] nullable

IDs of records of the KnowledgeBaseCategory type.

categoriesNamesobject nullable

An {ID => record name} map.

bodystring nullable

A multi-line text.

bodyPlainstring nullable

A multi-line text.

Example request

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

namestring

A one-line string.

status'Draft' | 'In Review' | 'Published' | 'Archived'
languagestring
type'Article'
portalsIdsstring[] nullable

IDs of records of the Portal type.

portalsNamesobject nullable

An {ID => record name} map.

publishDatestring date nullable

A date.

expirationDatestring date nullable

A date.

orderinteger nullable
descriptionstring nullable

A multi-line text.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

categoriesIdsstring[] nullable

IDs of records of the KnowledgeBaseCategory type.

categoriesNamesobject nullable

An {ID => record name} map.

bodystring nullable

A multi-line text.

bodyPlainstring nullable

A multi-line text.

Example response

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56"
}