vértice
Produto Preços Painel
Admin

Plano, status, limites e suspensão

Ajusta plano, status, limites, suspensão e dias de teste de um workspace.

Chave mestra Plataforma
Exemplo de requisição
curl -X PATCH "https://seu-dominio/admin/tenants/:id" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"plan":"business","status":"active"}'
PATCH /admin/tenants/{id}
Chave mestra
Entenda

Conceituação

Ajusta plano, status, limites, suspensão e dias de teste de um workspace.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

Chave mestra da plataforma. Não distribua a clientes.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID do workspace.

Body

plan string opcional

ID do plano: starter, pro ou business.

status string opcional

Status do workspace na plataforma.

Payload

Request Body

{
  "plan": "business",
  "status": "active"
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.