Create categories

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

import requests

url = "https://wisepim.com/api/public/v1/categories"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://wisepim.com/api/public/v1/categories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 123,
  "name": "<string>",
  "slug": "<string>",
  "level": 123,
  "is_active": true,
  "sort_order": 123,
  "hierarchy_path": "<string>",
  "parent_id": 123,
  "description": "<string>",
  "external_code": "<string>",
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_keywords": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "detail": [
    {}
  ]
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

POST

api

public

categories

Create categories

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

import requests

url = "https://wisepim.com/api/public/v1/categories"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://wisepim.com/api/public/v1/categories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 123,
  "name": "<string>",
  "slug": "<string>",
  "level": 123,
  "is_active": true,
  "sort_order": 123,
  "hierarchy_path": "<string>",
  "parent_id": 123,
  "description": "<string>",
  "external_code": "<string>",
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_keywords": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "detail": [
    {}
  ]
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "request_id": "<string>",
  "code": "<string>"
}

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

name

string

required

Maximum string length: 255

parent

integer | null

Required range: x > 0

description

string | null

meta_title

string | null

Maximum string length: 255

meta_description

string | null

Maximum string length: 100000

meta_keywords

string | null

Maximum string length: 255

is_active

boolean

sort_order

integer

name_localized

Name Localized · object

Localized category names keyed by locale code

Show child attributes

description_localized

Description Localized · object

Localized category descriptions keyed by locale code

Show child attributes

meta_title_localized

Meta Title Localized · object

Localized meta titles keyed by locale code

Show child attributes

meta_description_localized

Meta Description Localized · object

Localized meta descriptions keyed by locale code

Show child attributes

meta_keywords_localized

Meta Keywords Localized · object

Localized meta keywords keyed by locale code

Show child attributes

industry_slug

string | null

Optional industry override for scoring products under this category. Empty falls back to the project's primary_industry.

Maximum string length: 50

faqs

Faqs · object[] | null

Ordered FAQ items: [{"id", "question", "answer"}]. Answers are limited HTML.

faqs_localized

Faqs Localized · object | null

FAQ translations keyed by locale, then FAQ id

Show child attributes

append_faqs_to_products

boolean

Append this category's FAQs to the FAQs of every product directly in it

Response

Created

integer

required

name

string

required

slug

string

required

level

integer

required

is_active

boolean

required

sort_order

integer

required

hierarchy_path

string

required

parent_id

integer | null

description

string | null

external_code

string | null

meta_title

string | null

meta_description

string | null

meta_keywords

string | null

Get Started

Products

AI & Enrichment

Analytics

Automations

Quality Guard

Workflows

Projects & Teams

Settings

API Reference

Create categories

Authorizations

Headers

Body

Response