Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Project-Id
string

The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.

Path Parameters

id
string
required

ID of the wordlist to update

Body

application/json
name
string

New name for the wordlist

key
string

New key for the wordlist

description
string

New description for the wordlist

words
string[]

New words for the wordlist. Replace the existing words with these new ones. Words are converted to lowercase. Duplicate and empty words are ignored. Maximum 5000 words.

strict
boolean

Deprecated. Now using threshold in project settings.

Response

Wordlist updated successfully

id
string
required

ID of the wordlist

name
string | null
required

Name of the wordlist

words
string[]
required

Words in the wordlist

createdAt
string
required

Creation date of the wordlist

organizationId
string
required

ID of the organization

userId
string | null
required

ID of the user

strict
boolean
required

Strict mode