Informações do Projeto
Aprenda como atualizar o nome e descrição do seu projeto via API.
Atualizar Nome do Projeto
Altera o nome do projeto.
PATCH /project/:id/nameParâmetros de Path
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | string | ID do projeto (ObjectId) |
Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Novo nome do projeto (mínimo 6 caracteres, máximo 32, apenas letras minúsculas e números, pode usar hífen) |
Exemplo
{
"name": "meu-novo-projeto"
}Resposta
{
"status": "success",
"data": {
"id": "507f1f77bcf86cd799439011",
"name": "meu-novo-projeto"
}
}Atualizar Descrição do Projeto
Altera a descrição do projeto.
PATCH /project/:id/descriptionParâmetros de Path
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | string | ID do projeto (ObjectId) |
Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
description | string | Não | Nova descrição do projeto (máximo 256 caracteres) |
Resposta
{
"status": "success",
"message": "Description updated"
}Exemplos
Atualizar Nome
curl -X PATCH "https://api.zenifra.com/v1/project/507f1f77bcf86cd799439011/name" \
-H "x-api-key: sua-api-key" \
-H "Content-Type: application/json" \
-d '{"name": "meu-novo-projeto"}'Atualizar Descrição
curl -X PATCH "https://api.zenifra.com/v1/project/507f1f77bcf86cd799439011/description" \
-H "x-api-key: sua-api-key" \
-H "Content-Type: application/json" \
-d '{"description": "Minha aplicação web em produção"}'Python
import requests
API_KEY = "sua-api-key"
PROJECT_ID = "507f1f77bcf86cd799439011"
headers = {"x-api-key": API_KEY}
# Atualizar nome
requests.patch(
f"https://api.zenifra.com/v1/project/{PROJECT_ID}/name",
headers=headers,
json={"name": "meu-novo-projeto"}
)
# Atualizar descrição
requests.patch(
f"https://api.zenifra.com/v1/project/{PROJECT_ID}/description",
headers=headers,
json={"description": "Minha aplicação web em produção"}
)