Create keywords

POST /keywords. Required scopes: keywords:write.

POST /api/public/v1/keywords

Create keywords

cURL

curl --request POST \
  --url https://wisepim.com/api/public/v1/keywords \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "term": "<string>"
}
'

201

{
  "term": "<string>",
  "intent": "<string>",
  "kw_type": "<string>",
  "locale": "<string>",
  "target_fields": "<unknown>",
  "priority": 123,
  "notes": "<string>",
  "categories": [
    123
  ],
  "id": 123
}

Authorizations

Authorization · string · header · required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Headers

Idempotency-Key · string

Reuse this key for retries of the same write. Scoped to this API key; retained until key deletion. Different requests with the same key return 409.

Required string length: 1 - 128

Pattern: ^[!-~]+$

Body

application/json

term · string · required

Maximum string length: 255

intent · string

Classified search intent (from GSC query analysis).

Maximum string length: 16

kw_type · string

Positive = a term to target/include. Negative = a term to AVOID in generated content.

Maximum string length: 16

locale · string

Locale code this keyword applies to (e.g. 'nl', 'en-US'). Empty = applies to all locales.

Maximum string length: 16

target_fields · string[]

Subset of content fields this keyword applies to (title/description/short_description/seo_meta/attributes). Empty list = applies to all fields.

priority · integer

Relative importance; higher sorts first and weighs more.

notes · string

Maximum string length: 100000

categories · integer[]

If set, the keyword only applies to products in any of these categories. Empty = applies to every product.

Maximum array length: 500

Response

201

application/json

Created

term · string · required

Maximum string length: 255

intent · string · required

Classified search intent (from GSC query analysis).

Maximum string length: 16

kw_type · string · required

Positive = a term to target/include. Negative = a term to AVOID in generated content.

Maximum string length: 16

locale · string · required

Locale code this keyword applies to (e.g. 'nl', 'en-US'). Empty = applies to all locales.

Maximum string length: 16

target_fields · any · required

Subset of content fields this keyword applies to (title/description/short_description/seo_meta/attributes). Empty list = applies to all fields.

priority · integer · required

Relative importance; higher sorts first and weighs more.

notes · string · required

categories · integer[] · required

If set, the keyword only applies to products in any of these categories. Empty = applies to every product.

id · integer · required