Skip to main content
PUT
Atualizar produto

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Path Parameters

product_hash
string
required

Hash do produto

Body

application/json
name
string
required

Nome do produto.

Required string length: 3 - 191
category_id
integer
required

ID da categoria.

Required range: 1 <= x <= 999999
description
string
required

Descrição do produto.

Required string length: 3 - 1000
type
enum<string>
required

Tipo do produto.

Available options:
course,
ebook,
physical
support_email
string<email>
required

E-mail de suporte.

Maximum string length: 191
support_phone
string
required

Telefone de suporte (opcional).

Maximum string length: 20
Example:

"11999999999"

refund_deadline
enum<integer>
required

Prazo de reembolso em dias.

Available options:
7,
15,
30
Required range: 7 <= x <= 30
soft_descriptor
string
required

Descritor que aparece na fatura do cartão do comprador (apenas alfanumérico, até 13 caracteres).

Maximum string length: 13
Pattern: ^[a-zA-Z0-9]+$
Example:

"MEUPRODUTO"

image_stock
file

Documento de garantia do produto.

  • Obrigatório apenas para produtos do tipo 'physical'
  • Formatos aceitos: PNG, JPG, JPEG
  • Tamanho máximo: 10MB
  • Para produtos físicos, enviar via multipart/form-data
cover_picture
string<url>

URL da imagem de capa (opcional).

status
enum<string>

Status do produto.

Available options:
draft,
pre-approved,
approved,
pending,
pending-correction,
reproved
has_auto_affiliation
boolean
default:false

Se permite afiliação automática para este produto.

allow_affiliation
boolean
default:true

Se permite afiliação (campo do produto).

affiliate_percentage
number

Percentual de comissão do afiliado. Obrigatório quando allow_affiliation é true.

Required range: 1 <= x <= 80
affiliate_commission_type
enum<string> | null

Tipo de atribuição de comissão do afiliado.

  • single_click — comissão vai para um único afiliado
  • multi_click — comissão é dividida entre primeiro e último clique
Available options:
single_click,
multi_click
first_click_percentage
number | null

Percentual de comissão atribuído ao afiliado do primeiro clique (multiclick). Aceita até 2 casas decimais. Se informado sem last_click_percentage, o complemento para 100% é calculado automaticamente.

Required range: 0.01 <= x <= 99.99
Example:

60

last_click_percentage
number | null

Percentual de comissão atribuído ao afiliado do último clique (multiclick). Aceita até 2 casas decimais. Se informado sem first_click_percentage, o complemento para 100% é calculado automaticamente. A soma de first_click_percentage + last_click_percentage deve ser 100.

Required range: 0.01 <= x <= 99.99
Example:

40

affiliation_description
string

Descrição do programa de afiliados. Obrigatório quando allow_affiliation é true.

Required string length: 50 - 1000
affiliation_terms
string

Termos do programa de afiliados. Obrigatório quando allow_affiliation é true.

Required string length: 50 - 1000
metadata
object

Metadados complementares do produto.

Response

Produto atualizado com sucesso

Objeto de retorno com os dados do produto.

hash
string
required

Hash único do produto.

name
string
required

Nome do produto.

category_id
integer
required

ID da categoria do produto.

Required range: 1 <= x <= 999999
description
string
required

Descrição do produto.

type
enum<string>
required

Tipo do produto.

Available options:
course,
ebook,
physical
support_email
string<email>
required

E-mail de suporte do produto.

support_phone
string
required

Telefone de suporte do produto.

Maximum string length: 20
Example:

"11999999999"

refund_deadline
enum<integer>
required

Prazo para reembolso (em dias).

Available options:
7,
15,
30
Required range: 7 <= x <= 30
status
enum<string>
required

Status do produto.

Available options:
draft,
pre-approved,
approved,
pending,
pending-correction,
reproved
created_at
string
required

Data de criação (formato YYYY-MM-DD HH:mm:ss)

Example:

"2026-01-15 14:30:00"

updated_at
string
required

Data de atualização (formato YYYY-MM-DD HH:mm:ss)

Example:

"2026-01-15 14:30:00"

soft_descriptor
string

Descritor que aparece na fatura do cartão do comprador.

Maximum string length: 13
Example:

"MEUPRODUTO"

image_stock
string<url>

URL do documento de garantia do produto (obrigatório para produtos físicos).

cover_picture
string<url>

URL da imagem de capa (opcional).

is_active
boolean

Indica se o produto está ativo.

has_auto_affiliation
boolean

Se permite afiliação automática para este produto.

allow_affiliation
boolean

Se permite afiliação (campo do produto).

affiliate_commission_type
enum<string> | null

Tipo de atribuição de comissão do afiliado (first = primeiro clique, last = último clique, multi = dividido).

Available options:
first,
last,
multi
first_click_percentage
number | null

Percentual de comissão do primeiro clique (multiclick).

Example:

60

last_click_percentage
number | null

Percentual de comissão do último clique (multiclick).

Example:

40

metadata
object

Metadados complementares do produto.