Skip to main content
POST
Adicionar um novo category

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

id
string
obrigatório

O identificador de slug do portal

Corpo

application/json
name
string

O nome da categoria

Exemplo:

"Category Name"

description
string

Uma descrição para a categoria

Exemplo:

"Category description"

position
integer

Posição da categoria na lista do portal para ordenar

Exemplo:

1

slug
string

O slug da categoria usado no URL

Exemplo:

"category-name"

locale
string

A localidade da categoria

Exemplo:

"en"

icon
string

O ícone da categoria como uma string (emoji)

Exemplo:

"📚"

parent_category_id
integer

Para definir a categoria pai, por exemplo, a documentação do produto possui recursos de vários níveis na categoria de vendas ou na categoria de engenharia.

Exemplo:

1

associated_category_id
integer

Para associar categorias semelhantes entre si, por exemplo, mesma categoria de documentação de produto em idiomas diferentes

Exemplo:

2

Resposta

Sucesso

id
integer
description
string

O conteúdo do texto.

locale
string
name
string
slug
string
position
integer
portal_id
integer
account_id
integer
associated_category_id
integer

Para associar categorias semelhantes entre si, por exemplo, mesma categoria de documentação de produto em idiomas diferentes

parent_category_id
integer

Para definir a categoria pai, por exemplo, a documentação do produto possui recursos de vários níveis na categoria de vendas ou na categoria de engenharia.