vértice
Produto Preços Painel
Parceiros

Criar instância para um workspace

Cria instância para um workspace.

Chave mestra Plataforma
Exemplo de requisição
curl -X POST "https://seu-dominio/partner/instances" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"tenantId":"uuid","name":"Cliente","webhookUrl":"https://.../hooks"}'
POST /partner/instances
Chave mestra
Entenda

Conceituação

Cria instância para 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.

Body

tenantId string opcional

Campo tenantId do corpo JSON.

name string opcional

Nome exibido do recurso, contato, enquete ou grupo.

webhookUrl string opcional

URL HTTPS que receberá os eventos assinados. HTTP/localhost só em desenvolvimento.

Payload

Request Body

{
  "tenantId": "uuid",
  "name": "Cliente",
  "webhookUrl": "https://.../hooks"
}
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.