Skip to main content
Create wordlist

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.

Body

application/json
name
string
required

Name of the wordlist

Required string length: 1 - 100
key
string

Key of the wordlist. Default: made from the name. If the key is already in use, a suffix is added.

description
string

Description of the wordlist

words
string[]

Words to add to the wordlist. Words are converted to lowercase. Duplicate and empty words are ignored. Maximum 5000 words.

Response

Wordlist created 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