Atualizar Projeto

PATCH /api/projects/:id

Renomeia um projeto. O nome é o único campo editável de um projeto, então name é obrigatório mesmo que o método seja PATCH. A audiência raiz é editada com PATCH /api/audience-criterias/:id — veja Projetos → Audiência raiz.

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

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

Parâmetros de Rota

Parâmetro	Tipo	Descrição
`id`	UUID	ID do projeto

Corpo da Requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Novo nome do projeto (máximo de 255 caracteres). Deve ser único dentro do tenant, sem diferenciar maiúsculas de minúsculas; um projeto pode mudar as maiúsculas do seu próprio nome

isMain não pode ser alterado: enviá-lo (ou qualquer campo diferente de name) responde 400.

Exemplo

curl -X PATCH https://api.reten.ai/api/projects/b7e4d2c1-6a5f-4e3d-9c8b-7a6f5e4d3c2b \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Food Service Norte"
  }'

const id = "b7e4d2c1-6a5f-4e3d-9c8b-7a6f5e4d3c2b";
const response = await fetch(`https://api.reten.ai/api/projects/${id}`, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Food Service Norte",
  }),
});
const project = await response.json();

import requests

project_id = "b7e4d2c1-6a5f-4e3d-9c8b-7a6f5e4d3c2b"
response = requests.patch(
    f"https://api.reten.ai/api/projects/{project_id}",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
    json={
        "name": "Food Service Norte",
    },
)
project = response.json()

Resposta `200 OK`

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

Respostas de Erro

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