Comunidades

Metadados de convite de comunidade

Metadados de convite de comunidade.

API key Escopo read

Exemplo de requisição

curl -X GET "https://seu-dominio/instances/:id/communities/invite/:code" \
  -H "x-api-key: $VERTICE_API_KEY"

const response = await fetch('https://seu-dominio/instances/:id/communities/invite/:code', {
  method: 'GET',
  headers: {
  'x-api-key': process.env.VERTICE_API_KEY ?? '',
  },
});

const payload = await response.json();
console.log(payload);

GET /instances/{id}/communities/invite/{code}

API key

Entenda

Conceituação

Metadados de convite de comunidade.

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

Contrato

Atributos

3 campos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Path

id string obrigatório

ID da instância.

code string obrigatório

Código do convite, TOTP ou verificação.

Contrato

Resposta

200

{
  "data": {
    "id": "..."
  }
}

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.