Newer Version Available

This content describes an older version of this product. View Latest

KeywordList

Represents a list of keywords used in community moderation. Available in Tooling API version 36.0 and later.

This keyword list is a type of moderation criteria that defines offensive language or inappropriate content that you don’t want in your community.

Supported SOAP Calls

create(), delete(), query(), retrieve(), update()

Supported REST HTTP Methods

DELETE, GET, PATCH, POST

Fields

Field Details
Description
Type
textarea
Properties
Filter, Nillable, Sort.
Description
A description of the keyword list.
DeveloperName
Type
string
Properties
Filter, Group, Namefield, Sort
Description
The developer’s internal name for the keyword list used in the API.
FullName
Type
string
Properties
Create, Group, Nillable.
Description
The full name of the associated metadata object in Metadata API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort.
Description
The language of the keyword list. Valid values are:
  • Chinese (Simplified): zh_CN
  • Chinese (Traditional): zh_TW
  • Danish: da
  • Dutch: nl_NL
  • English: en_US
  • Finnish: fi
  • French: fr
  • German: de
  • Italian: it
  • Japanese: ja
  • Korean: ko
  • Norwegian: no
  • Portuguese (Brazil): pt_BR
  • Russian: ru
  • Spanish: es
  • Spanish (Mexico): es_MX
  • Swedish: sv
  • Thai: th
MasterLabel
Type
string
Properties
Filter, Group, Sort.
Description
Label for the keyword list.
Metadata
Type
mns:KeywordList
Properties
Create, Nillable, Update.
Description
KeywordList metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.