API/Instâncias/Criar instância

Criar instância

Cria uma nova instância do WhatsApp. Cada instância possui uma API Key única e mantém sua própria sessão.

POST/instance/create

Body Parameters

namestringrequired

Nome único da instância (usado para identificação)

Response

200Instância criada com sucesso

Campo	Tipo	Descrição
`success`	boolean	Indica se a operação foi bem-sucedida
`data.instance.id`	UUID	ID único da instância
`data.instance.name`	string	Nome da instância
`data.instance.api_key`	string	Chave de API única para esta instância
`data.instance.status`	string	Status inicial (geralmente 'disconnected')
`data.instance.created_at`	ISO8601	Data de criação da instância

200 - application/json

{
  "success": true,
  "data": {
    "instance": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "minha-instancia",
      "api_key": "550e8400-e29b-41d4-a716-446655440000",
      "status": "disconnected",
      "created_at": "2024-01-15T10:30:00.000Z"
    }
  }
}

400Erro de validação

400 - application/json

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Nome da instância é obrigatório"
  }
}

409Instância já existe

409 - application/json

{
  "success": false,
  "error": {
    "code": "INSTANCE_EXISTS",
    "message": "Uma instância com este nome já existe"
  }
}

POST/instance/create

Cria uma nova instância do WhatsApp. Cada instância possui uma API Key única e mantém sua própria sessão.

Example Response

200

{
  "success": true,
  "data": {
    "instance": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "minha-instancia",
      "api_key": "550e8400-e29b-41d4-a716-446655440000",
      "status": "disconnected",
      "created_at": "2024-01-15T10:30:00.000Z"
    }
  }
}