Reten Docs
Projetos

Criar Projeto

Criar um projeto no tenant ativo, junto com sua audiência raiz.

POST /api/projects

Cria um projeto no tenant ativo. O projeto é criado junto com sua audiência raiz, Toda la empresa (os comércios ativos), em uma única operação: a resposta já traz seu rootAudienceId.

Auth: Necessária — permissão project:create

Este endpoint é tenant-level: ignora o header x-project-id.

Corpo da Requisição

CampoTipoObrigatórioDescrição
namestringSimNome do projeto (máximo de 255 caracteres). Deve ser único dentro do tenant, sem diferenciar maiúsculas de minúsculas

name é o único campo aceito. Um projeto novo nunca é o projeto principal: enviar isMain (ou qualquer outro campo) responde 400.

Exemplo

curl -X POST https://api.reten.ai/api/projects \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Food Service"
  }'
const response = await fetch("https://api.reten.ai/api/projects", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Food Service",
  }),
});
const project = await response.json();
import requests

response = requests.post(
    "https://api.reten.ai/api/projects",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
    json={
        "name": "Food Service",
    },
)
project = response.json()

Resposta 201 Created

{
  "id": "b7e4d2c1-6a5f-4e3d-9c8b-7a6f5e4d3c2b",
  "name": "Food Service",
  "rootAudienceId": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
  "isMain": false
}

Respostas de Erro

StatusDescrição
400name ausente ou vazio — El nombre del proyecto es obligatorio.
400name não é texto — El nombre del proyecto debe ser texto.
400name ultrapassa 255 caracteres — El nombre del proyecto no puede superar los 255 caracteres.
400Campo desconhecido no corpo, como isMain — property isMain should not exist
401Token de autenticação ausente ou inválido
403Falta a permissão project:create — Required permissions: project:create
409Outro projeto do tenant já tem esse nome (sem diferenciar maiúsculas de minúsculas) — Ya existe un proyecto con el nombre "<name>".