Pular para o conteúdo
NexoNexo · API e MCP

Renomear ou trocar o tipo de um material

PATCH
/v1/knowledge/materials/{materialId}
curl --request PATCH \
  --url https://developers.nexo.winningsales.com.br/v1/knowledge/materials/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "category": "policy" }'

O arquivo não muda; para trocá-lo, suba uma versão nova. Só administradores, como a Base de conhecimento na tela Calibração; o papel é relido a cada chamada, e para mudar o token precisa do escopo calibration:write.

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
materialId
required

Id do material

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
name

Novo nome do material

string
>= 1 characters <= 200 characters
category

Tipo do material: policy (política), playbook, pricing (preços), product (produto), case, presentation (apresentação) ou other (outro)

string
Allowed values: policy playbook pricing product case presentation other

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Material alterado

Media typeapplication/json
object
id
required

Id do material

string format: uuid
name
required

Nome do material na base

string
category
required

Tipo do material: policy (política), playbook, pricing (preços), product (produto), case, presentation (apresentação) ou other (outro)

string
Allowed values: policy playbook pricing product case presentation other
fileName
required

Nome do arquivo da versão atual, usado no download

string
format
required

Formato da versão atual

string
Allowed values: pdf docx pptx xlsx md txt
sizeInBytes
required

Tamanho da versão atual em bytes. Antes da confirmação, o tamanho informado no pedido

integer
version
required

Número da versão atual, começando em 1

integer
status
required

Awaiting_upload: o arquivo ainda não foi confirmado; stored: guardado; rejected: recusado na confirmação

string
Allowed values: awaiting_upload stored rejected
uploadedAt
required

Quando a versão atual foi guardada, ou pedida quando ainda não chegou

string format: date-time
uploadedBy
required

Quem subiu a versão atual. Null quando a pessoa não está mais na empresa

object
id
required

Id de quem subiu

string format: uuid
name
required

Nome de quem subiu

string

Example 

{
  "category": "policy",
  "format": "pdf",
  "status": "awaiting_upload"
}

400

Seção intitulada “400”

Payload inválido (detalhes do zod em meta.errors)

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

401

Seção intitulada “401”

Token ausente, inválido, expirado ou revogado

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example 

{
  "type": "public_api.invalid_credential",
  "title": "InvalidCredentialError",
  "status": 401,
  "detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

403

Seção intitulada “403”

Papel, escopo do token ou plano não permitem a operação

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example 

{
  "type": "public_api.insufficient_scope",
  "title": "InsufficientScopeError",
  "status": 403,
  "detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "operation": "conversations.reading",
    "scope": "conversations:read"
  }
}

404

Seção intitulada “404”

Material inexistente ou removido

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example 

{
  "type": "knowledge.material_not_found",
  "title": "MaterialNotFoundError",
  "status": 404,
  "detail": "Material não encontrado na base de conhecimento.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "materialId": "019fcae7-3e54-755a-8458-bdb605b324aa"
  }
}

429

Seção intitulada “429”

Limite de chamadas da empresa ou do token atingido

Media typeapplication/json
object
type
required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string
title
required

Error class name

string
status
required

HTTP status code

integer
detail
required

Human-readable message, safe to display to end users

string
requestId
required

Correlation id — send it to support to locate the full trail

string
nullable
meta

Structured details safe for the frontend (field errors, ids)

object
key
additional properties

Example 

{
  "type": "public_api.rate_limited",
  "title": "PublicRateLimitedError",
  "status": 429,
  "detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "class": "content",
    "limitedBy": "company",
    "limit": 120,
    "windowSeconds": 60,
    "retryAfterSeconds": 12
  }
}