AHahrefs
Management

Create Keyword list

Changed on

Requests to this endpoint are free and do not consume any API units.

post/management/keyword-lists

Request

  • Base URL
    https://api.ahrefs.com/v3
  • URL
    https://api.ahrefs.com/v3/management/keyword-lists
  • Auth
    HTTP bearer

Query parameters

output'json' | 'php' | 'xml'

The output format.

Request body

namestring required

The name of the keyword list.

location'all' | 'af' | 'al' | 'dz' | 'as' | 'ad' | 'ao' | 'ai' | 'ag' | 'ar' | 'am' | 'au' | 'at' | 'az' | 'bs' | 'bh' | 'bd' | 'by' | 'be' | 'bz' | 'bj' | 'bt' | 'bo' | 'ba' | 'bw' | 'br' | 'bn' | 'bg' | 'bf' | 'bi' | 'kh' | 'cm' | 'ca' | 'cv' | 'cf' | 'td' | 'cl' | 'co' | 'cg' | 'cd' | 'ck' | 'cr' | 'ci' | 'hr' | 'cy' | 'cz' | 'dk' | 'dj' | 'dm' | 'do' | 'ec' | 'eg' | 'sv' | 'ee' | 'et' | 'fj' | 'fi' | 'fr' | 'ga' | 'gm' | 'ge' | 'de' | 'gh' | 'gi' | 'gr' | 'gl' | 'gp' | 'gt' | 'gg' | 'gy' | 'ht' | 'hn' | 'hk' | 'hu' | 'is' | 'in' | 'id' | 'iq' | 'ie' | 'il' | 'it' | 'jm' | 'jp' | 'je' | 'jo' | 'kz' | 'ke' | 'ki' | 'kw' | 'kg' | 'la' | 'lv' | 'lb' | 'ls' | 'ly' | 'li' | 'lt' | 'lu' | 'mg' | 'mw' | 'my' | 'mv' | 'ml' | 'mt' | 'mu' | 'mx' | 'fm' | 'md' | 'mn' | 'me' | 'ms' | 'ma' | 'mz' | 'mm' | 'na' | 'nr' | 'np' | 'nl' | 'nz' | 'ni' | 'ne' | 'ng' | 'nu' | 'mk' | 'no' | 'om' | 'pk' | 'ps' | 'pa' | 'pg' | 'py' | 'pe' | 'ph' | 'pn' | 'pl' | 'pt' | 'pr' | 'qa' | 'ro' | 'ru' | 'rw' | 'sh' | 'vc' | 'ws' | 'sm' | 'st' | 'sa' | 'sn' | 'rs' | 'sc' | 'sl' | 'sg' | 'sk' | 'si' | 'sb' | 'so' | 'za' | 'kr' | 'es' | 'lk' | 'sr' | 'se' | 'ch' | 'tw' | 'tj' | 'tz' | 'th' | 'tl' | 'tg' | 'tk' | 'to' | 'tt' | 'tn' | 'tr' | 'tm' | 'ug' | 'ua' | 'ae' | 'gb' | 'us' | 'uy' | 'uz' | 'vu' | 've' | 'vn' | 'vg' | 'vi' | 'zm' | 'zw' required

The location of the keyword list. Specify a country code for one country, or 'all' for all locations. When using 'all', optionally provide 'countries' to restrict the list to selected countries. All locations and selections of multiple countries require Global Mode.

countriesstring[]

Up to 15 country codes to select when location is 'all'. Omit for all locations.

keywordsstring[]

Initial keywords to add. Each may contain at most 255 characters.

access'private' | 'shared'

The access type of the keyword list.

owned_bystring

The email of the keyword list owner. Defaults to the API key's owner.

folder_idinteger

The ID of the folder to assign the keyword list to.

Response

OK

Changes