Criar Produto

cURL

curl --request POST \
  --url https://api.cakto.com.br/public_api/products/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "price": "<string>",
  "salesPage": "<string>",
  "emailAccessLink": "<string>",
  "contentDeliveries": [],
  "paymentMethods": [
    "<string>"
  ]
}
'

import requests

url = "https://api.cakto.com.br/public_api/products/"

payload = {
    "name": "<string>",
    "description": "<string>",
    "price": "<string>",
    "salesPage": "<string>",
    "emailAccessLink": "<string>",
    "contentDeliveries": [],
    "paymentMethods": ["<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>',
    description: '<string>',
    price: '<string>',
    salesPage: '<string>',
    emailAccessLink: '<string>',
    contentDeliveries: [],
    paymentMethods: ['<string>']
  })
};

fetch('https://api.cakto.com.br/public_api/products/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cakto.com.br/public_api/products/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'price' => '<string>',
    'salesPage' => '<string>',
    'emailAccessLink' => '<string>',
    'contentDeliveries' => [
        
    ],
    'paymentMethods' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.cakto.com.br/public_api/products/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": \"<string>\",\n  \"salesPage\": \"<string>\",\n  \"emailAccessLink\": \"<string>\",\n  \"contentDeliveries\": [],\n  \"paymentMethods\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.post("https://api.cakto.com.br/public_api/products/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": \"<string>\",\n  \"salesPage\": \"<string>\",\n  \"emailAccessLink\": \"<string>\",\n  \"contentDeliveries\": [],\n  \"paymentMethods\": [\n    \"<string>\"\n  ]\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.cakto.com.br/public_api/products/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": \"<string>\",\n  \"salesPage\": \"<string>\",\n  \"emailAccessLink\": \"<string>\",\n  \"contentDeliveries\": [],\n  \"paymentMethods\": [\n    \"<string>\"\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "cd287b31-d4b7-4e94-858a-66e05ce2f4a2",
  "short_id": "19bruPi",
  "name": "Product Name Example",
  "status": "active",
  "type": "unique",
  "description": "Description example",
  "category": "0673d296-1802-45e0-bc93-112f7514dddb",
  "price": "5.00",
  "installments": 12,
  "image": null,
  "guarantee": 7,
  "salesPage": "https://example-sales-page.com.br/product-page",
  "supportEmail": "teste@teste.com",
  "supportWhatsapp": null,
  "contentDeliveries": [
    "cakto",
    "telegram",
    "discord"
  ],
  "emailAccessLink": null,
  "confirmEmail": false,
  "affiliate": true,
  "affiliateRequest": false,
  "affiliateCommission": "10.00",
  "affiliateContact": false,
  "affiliateDescription": "teste",
  "affiliateSupportEmail": "",
  "affiliateMarketplace": false,
  "affiliateClick": "last",
  "cookieTime": -1,
  "affiliateShareBump": false,
  "affiliateShareUpsell": false,
  "affiliateCloneQuiz": false,
  "affiliateCloneQuizUrl": "",
  "affiliateSalesPage": "",
  "upsell": false,
  "upsellPage": "",
  "redirectUpsellWithBumpFail": true,
  "defaultPaymentMethod": "credit_card",
  "showCouponField": true,
  "showAddressFields": false,
  "threeDsRetryEnabled": true,
  "offers": [
    {
      "id": "77BcHrY",
      "name": "Product Name Example",
      "image": null,
      "price": 5,
      "units": 1,
      "default": true,
      "status": "active",
      "cost_per_item": "0.00",
      "profit_per_item": "0.00",
      "type": "unique",
      "intervalType": "year",
      "interval": 1,
      "recurrence_period": 30,
      "quantity_recurrences": -1,
      "trial_days": 0,
      "max_retries": 3,
      "retry_interval": 1,
      "checkout": 200300400,
      "height": null,
      "width": null,
      "length": null,
      "weight": null
    }
  ],
  "invoiceDescription": "CardDesc",
  "paymentMethods": [
    "boleto",
    "credit_card",
    "picpay",
    "pix"
  ],
  "paymentsOrder": [
    "openfinance_nubank",
    "credit_card",
    "boleto",
    "pix",
    "picpay",
    "applepay",
    "googlepay"
  ],
  "ticketExpiration": 7,
  "pixExpiresIn": 3600,
  "twoCardPayment": false,
  "bumps": [],
  "tracking_pixels": {
    "id": 200300400,
    "fbPixPurchaseTrigger": true,
    "fbPixConversionValue": 50,
    "fbBoletoPurchaseTrigger": true,
    "fbBoletoConversionValue": 100,
    "fbPicpayPurchaseTrigger": true,
    "fbPicpayConversionValue": 100,
    "fbNubankPurchaseTrigger": true,
    "fbNubankConversionValue": 100,
    "googleAnalyticsTrackingId": null,
    "tiktokPixPurchaseTrigger": true,
    "tiktokPixConversionValue": 100,
    "tiktokBoletoPurchaseTrigger": true,
    "tiktokBoletoConversionValue": 100,
    "tiktokPicpayPurchaseTrigger": true,
    "tiktokPicpayConversionValue": 100,
    "tiktokNubankPurchaseTrigger": true,
    "tiktokNubankConversionValue": 100,
    "kwaiPixPurchaseTrigger": true,
    "kwaiPixConversionValue": 100,
    "kwaiBoletoPurchaseTrigger": true,
    "kwaiBoletoConversionValue": 100,
    "kwaiPicpayPurchaseTrigger": true,
    "kwaiPicpayConversionValue": 100,
    "kwaiNubankPurchaseTrigger": true,
    "kwaiNubankConversionValue": 100,
    "facebook_pixels": [
      {
        "id": 200300400,
        "name": null,
        "description": null,
        "status": "active",
        "pixelId": "123456789010102030",
        "error": null,
        "domain": "",
        "apiToken": "TokenExample123",
        "fbPixPurchaseTrigger": null,
        "fbPixConversionValue": null,
        "fbBoletoPurchaseTrigger": null,
        "fbBoletoConversionValue": null,
        "fbPicpayPurchaseTrigger": null,
        "fbPicpayConversionValue": null,
        "fbNubankPurchaseTrigger": null,
        "fbNubankConversionValue": null,
        "createdAt": "2022-09-01T17:43:12.795070-03:00"
      }
    ],
    "google_ads_pixels": [],
    "taboola_pixels": [],
    "outbrain_pixels": [],
    "tiktok_pixels": [],
    "kwai_pixels": [],
    "pixel_domains": []
  },
  "disable_orderbump_pixel_events": true,
  "producerName": "Testeando",
  "createdAt": "2022-03-28T13:04:26.191272-03:00",
  "updatedAt": "2027-11-26T22:16:34.095632-03:00"
}

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

POST

public_api

products

cURL

curl --request POST \
  --url https://api.cakto.com.br/public_api/products/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "price": "<string>",
  "salesPage": "<string>",
  "emailAccessLink": "<string>",
  "contentDeliveries": [],
  "paymentMethods": [
    "<string>"
  ]
}
'

import requests

url = "https://api.cakto.com.br/public_api/products/"

payload = {
    "name": "<string>",
    "description": "<string>",
    "price": "<string>",
    "salesPage": "<string>",
    "emailAccessLink": "<string>",
    "contentDeliveries": [],
    "paymentMethods": ["<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>',
    description: '<string>',
    price: '<string>',
    salesPage: '<string>',
    emailAccessLink: '<string>',
    contentDeliveries: [],
    paymentMethods: ['<string>']
  })
};

fetch('https://api.cakto.com.br/public_api/products/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cakto.com.br/public_api/products/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'price' => '<string>',
    'salesPage' => '<string>',
    'emailAccessLink' => '<string>',
    'contentDeliveries' => [
        
    ],
    'paymentMethods' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.cakto.com.br/public_api/products/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": \"<string>\",\n  \"salesPage\": \"<string>\",\n  \"emailAccessLink\": \"<string>\",\n  \"contentDeliveries\": [],\n  \"paymentMethods\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.post("https://api.cakto.com.br/public_api/products/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": \"<string>\",\n  \"salesPage\": \"<string>\",\n  \"emailAccessLink\": \"<string>\",\n  \"contentDeliveries\": [],\n  \"paymentMethods\": [\n    \"<string>\"\n  ]\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.cakto.com.br/public_api/products/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"price\": \"<string>\",\n  \"salesPage\": \"<string>\",\n  \"emailAccessLink\": \"<string>\",\n  \"contentDeliveries\": [],\n  \"paymentMethods\": [\n    \"<string>\"\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "cd287b31-d4b7-4e94-858a-66e05ce2f4a2",
  "short_id": "19bruPi",
  "name": "Product Name Example",
  "status": "active",
  "type": "unique",
  "description": "Description example",
  "category": "0673d296-1802-45e0-bc93-112f7514dddb",
  "price": "5.00",
  "installments": 12,
  "image": null,
  "guarantee": 7,
  "salesPage": "https://example-sales-page.com.br/product-page",
  "supportEmail": "teste@teste.com",
  "supportWhatsapp": null,
  "contentDeliveries": [
    "cakto",
    "telegram",
    "discord"
  ],
  "emailAccessLink": null,
  "confirmEmail": false,
  "affiliate": true,
  "affiliateRequest": false,
  "affiliateCommission": "10.00",
  "affiliateContact": false,
  "affiliateDescription": "teste",
  "affiliateSupportEmail": "",
  "affiliateMarketplace": false,
  "affiliateClick": "last",
  "cookieTime": -1,
  "affiliateShareBump": false,
  "affiliateShareUpsell": false,
  "affiliateCloneQuiz": false,
  "affiliateCloneQuizUrl": "",
  "affiliateSalesPage": "",
  "upsell": false,
  "upsellPage": "",
  "redirectUpsellWithBumpFail": true,
  "defaultPaymentMethod": "credit_card",
  "showCouponField": true,
  "showAddressFields": false,
  "threeDsRetryEnabled": true,
  "offers": [
    {
      "id": "77BcHrY",
      "name": "Product Name Example",
      "image": null,
      "price": 5,
      "units": 1,
      "default": true,
      "status": "active",
      "cost_per_item": "0.00",
      "profit_per_item": "0.00",
      "type": "unique",
      "intervalType": "year",
      "interval": 1,
      "recurrence_period": 30,
      "quantity_recurrences": -1,
      "trial_days": 0,
      "max_retries": 3,
      "retry_interval": 1,
      "checkout": 200300400,
      "height": null,
      "width": null,
      "length": null,
      "weight": null
    }
  ],
  "invoiceDescription": "CardDesc",
  "paymentMethods": [
    "boleto",
    "credit_card",
    "picpay",
    "pix"
  ],
  "paymentsOrder": [
    "openfinance_nubank",
    "credit_card",
    "boleto",
    "pix",
    "picpay",
    "applepay",
    "googlepay"
  ],
  "ticketExpiration": 7,
  "pixExpiresIn": 3600,
  "twoCardPayment": false,
  "bumps": [],
  "tracking_pixels": {
    "id": 200300400,
    "fbPixPurchaseTrigger": true,
    "fbPixConversionValue": 50,
    "fbBoletoPurchaseTrigger": true,
    "fbBoletoConversionValue": 100,
    "fbPicpayPurchaseTrigger": true,
    "fbPicpayConversionValue": 100,
    "fbNubankPurchaseTrigger": true,
    "fbNubankConversionValue": 100,
    "googleAnalyticsTrackingId": null,
    "tiktokPixPurchaseTrigger": true,
    "tiktokPixConversionValue": 100,
    "tiktokBoletoPurchaseTrigger": true,
    "tiktokBoletoConversionValue": 100,
    "tiktokPicpayPurchaseTrigger": true,
    "tiktokPicpayConversionValue": 100,
    "tiktokNubankPurchaseTrigger": true,
    "tiktokNubankConversionValue": 100,
    "kwaiPixPurchaseTrigger": true,
    "kwaiPixConversionValue": 100,
    "kwaiBoletoPurchaseTrigger": true,
    "kwaiBoletoConversionValue": 100,
    "kwaiPicpayPurchaseTrigger": true,
    "kwaiPicpayConversionValue": 100,
    "kwaiNubankPurchaseTrigger": true,
    "kwaiNubankConversionValue": 100,
    "facebook_pixels": [
      {
        "id": 200300400,
        "name": null,
        "description": null,
        "status": "active",
        "pixelId": "123456789010102030",
        "error": null,
        "domain": "",
        "apiToken": "TokenExample123",
        "fbPixPurchaseTrigger": null,
        "fbPixConversionValue": null,
        "fbBoletoPurchaseTrigger": null,
        "fbBoletoConversionValue": null,
        "fbPicpayPurchaseTrigger": null,
        "fbPicpayConversionValue": null,
        "fbNubankPurchaseTrigger": null,
        "fbNubankConversionValue": null,
        "createdAt": "2022-09-01T17:43:12.795070-03:00"
      }
    ],
    "google_ads_pixels": [],
    "taboola_pixels": [],
    "outbrain_pixels": [],
    "tiktok_pixels": [],
    "kwai_pixels": [],
    "pixel_domains": []
  },
  "disable_orderbump_pixel_events": true,
  "producerName": "Testeando",
  "createdAt": "2022-03-28T13:04:26.191272-03:00",
  "updatedAt": "2027-11-26T22:16:34.095632-03:00"
}

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

Escopo

    write products

Ao criar um produto, a Cakto já gera a oferta padrão, o checkout e o link de pagamento (https://pay.cakto.com.br/{id_da_oferta}). Não existe um endpoint separado para “criar checkout” — o checkout é a vitrine do produto.Para o passo a passo completo, veja o guia Criar um checkout.

O preço mínimo e máximo permitidos dependem da moeda da oferta (currency) — os limites são configurados por moeda, não um valor fixo em reais. Um preço fora da faixa retorna 400 com o limite e o símbolo da moeda na mensagem.

Authorizations

Authorization

string

header

required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Body

name

string

required

Nome do produto

Maximum string length: 255

description

string

required

Descrição do produto

price

string<decimal>

Preço do produto

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

currency

enum<string>

Moeda do produto

BRL - Real
EUR - Euro
MXN - Peso Mexicano
PEN - Sol Peruano
USD - Dólar
CLP - Peso Chileno
COP - Peso Colombiano
ARS - Peso Argentino
BOB - Boliviano
UYU - Peso Uruguayo

Available options:

BRL,

EUR,

MXN,

PEN,

USD,

CLP,

COP,

ARS,

BOB,

UYU

type

enum<string>

Tipo de venda do produto, ex.: venda única, assinatura...

unique - Pagamento único
subscription - Assinatura recorrente

Available options:

unique,

subscription

salesPage

string<uri> | null

Link da página de vendas do produto

Maximum string length: 2048

status

enum<string>

Status atual do produto

active - Ativo
waiting_config - Aguardando Configuração
blocked - Bloqueado
deleted - Deletado

Available options:

active,

waiting_config,

blocked,

deleted

emailAccessLink

string<uri> | null

Link a ser enviado por e-mail para acesso ao conteúdo após a compra

Maximum string length: 2048

contentDeliveries

enum<string>[]

Por qual(is) meio(s) o conteúdo será entregue ao cliente

Available options:

external,

cakto,

cakto_v2,

cakto_v3,

telegram,

discord,

emailAccess,

files,

disabled

paymentMethods

string[]

Métodos de pagamento disponíveis para o produto

Response

Corpo da resposta status 201

Secure file replacement (context)

When an update replaces an existing uploaded file (e.g. a profile picture), the old file usually remains in storage unless you explicitly delete it. Over time, this leaves orphaned files and increases storage costs.

What this class does

This is an opt-in base serializer that deletes old files from storage after a successful update that replaces (or clears) a Django models.FileField / models.ImageField.

It is configured via Meta.delete_replaced_files_fields:

As a list/tuple/set of field names, or
As a dict mapping field name → options.

Supported options (per field)

delete_on_clear (bool, default True): when the update sets the field to None/empty, delete the previous stored file.

Example usage (simple)

class UserUpdateSerializer(DeleteOldFilesMixin, serializers.ModelSerializer):  # DeleteOldFilesMixin should be first that the actual serializer
    class Meta:
        model = User
        fields = ["id", "picture", "first_name", "last_name"]
        delete_replaced_files_fields = ["picture"]

Example usage (per-field options)

class DocumentUpdateSerializer(DeleteOldFilesMixin, serializers.ModelSerializer):  # DeleteOldFilesMixin should be first that the actual serializer
    class Meta:
        model = Document
        fields = ["id", "picture", "document_image"]
        delete_replaced_files_fields = {
            "picture": {"delete_on_clear": True},
            "document_image": {"delete_on_clear": False},
        }

name

string

required

Nome do produto

Maximum string length: 255

description

string

required

Descrição do produto

contentDeliveries

enum<string>[]

required

Métodos de entrega de conteúdo do produto

Available options:

external,

cakto,

cakto_v2,

cakto_v3,

telegram,

discord,

emailAccess,

files,

disabled

member_area

string

required

read-only

ID da área de membros

offers

object[]

required

read-only

Show child attributes

paymentMethods

enum<string>[]

required

Métodos de pagamento que o produto aceita

pix - Pix
pix_auto - Pix Automático
boleto - Boleto
credit_card - Cartão de Crédito
debit_card - Cartão de Débito
threeDs - Cartão de Crédito 3DS
picpay - Pic Pay
pagaleve - Pagaleve
googlepay - Google Pay
applepay - Apple Pay
paypal_wallet - PayPal Wallet
openfinance_nubank - Nubank
mercadopago_wallet - Mercado Pago Wallet
oxxo - OXXO
spei - SPEI
pse - PSE
nequi - Nequi
safetypay - SafetyPay

Available options:

pix,

pix_auto,

boleto,

credit_card,

debit_card,

threeDs,

picpay,

pagaleve,

googlepay,

applepay,

paypal_wallet,

openfinance_nubank,

mercadopago_wallet,

oxxo,

spei,

pse,

nequi,

safetypay

bumps

object[]

required

read-only

Orderbumps do produto

Show child attributes

tracking_pixels

object

required

Show child attributes

createdAt

string<date-time>

required

read-only

Data e hora de criação

updatedAt

string<date-time>

required

read-only

Data e hora da última atualização

string

Identificador único do produto

Maximum string length: 255

short_id

string

Identificador curto do produto

Maximum string length: 40

status

enum<string>

Status atual do produto

active - Ativo
waiting_config - Aguardando Configuração
blocked - Bloqueado
deleted - Deletado

Available options:

active,

waiting_config,

blocked,

deleted

type

enum<string>

Tipo de venda do produto, ex.: venda única, assinatura...

unique - Pagamento único
subscription - Assinatura recorrente

Available options:

unique,

subscription

Comece aqui

Conceitos

Cakto SDK

CaktoMCP

Pagamentos

Pedidos

Webhooks

Produtos

Checkouts

Ofertas

Order Bumps

Clientes

Taxas e Prazos

Juro de Parcelamento

Assinaturas

Escopo

Authorizations

Body

Response

Secure file replacement (context)

What this class does

Supported options (per field)

Example usage (simple)

Example usage (per-field options)

​Escopo

Authorizations

Body

Response

Secure file replacement (context)

What this class does

Supported options (per field)

Example usage (simple)

Example usage (per-field options)

Escopo