> ## Documentation Index
> Fetch the complete documentation index at: https://developer.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Criando uma instância

> Cria uma instância vinculada à sua conta de parceiro integrador

## Conceituação

Método utilizado para criar uma instância vinculada a sua conta.

<Info>
  Você não precisa necessariamente assinar a instância neste momento pois você tem 2 dias para utilizar como trial. Após 2 dias sem assinatura, a instância é automaticamente deletada.
</Info>

<Warning>
  Para utilizar os endpoints de Partner, informe o Token de Parceiro no campo **Authorization**, no formato: `Bearer <Partner-Token>`

  Não é necessário enviar o **Client-Token** nessas requisições.
</Warning>

***

## Atributos

### Header

### Obrigatórios

<ParamField body="name" type="string" required>
  Nome da instância
</ParamField>

### Opcionais

<ParamField body="sessionName" type="string">
  Nome da sessão nos dispositivos conectados
</ParamField>

<ParamField body="deliveryCallbackUrl" type="string">
  URL webhook de mensagens enviadas
</ParamField>

<ParamField body="receivedCallbackUrl" type="string">
  URL webhook de mensagens recebidas
</ParamField>

<ParamField body="receivedAndDeliveryCallbackUrl" type="string">
  URL webhook de mensagens recebidas e enviadas por mim
</ParamField>

<ParamField body="presenceChatCallbackUrl" type="string">
  URL webhook status do chat
</ParamField>

<ParamField body="disconnectedCallbackUrl" type="string">
  URL webhook de desconexão
</ParamField>

<ParamField body="connectedCallbackUrl" type="string">
  URL webhook de conexão
</ParamField>

<ParamField body="messageStatusCallbackUrl" type="string">
  URL webhook status da mensagem
</ParamField>

<ParamField body="callRejectAuto" type="boolean">
  Rejeitar chamadas automaticamente
</ParamField>

<ParamField body="callRejectMessage" type="string">
  Mensagem ao rejeitar chamada
</ParamField>

<ParamField body="autoReadMessage" type="boolean">
  Leitura automática de mensagens
</ParamField>

<ParamField body="autoReadStatus" type="boolean">
  Leitura automática de status
</ParamField>

<ParamField body="isDevice" type="boolean">
  Instância mobile (true) ou web (false)
</ParamField>

<ParamField body="businessDevice" type="boolean">
  Versão WhatsApp Business
</ParamField>

<ParamField body="disableEnqueueWhenDisconnected" type="boolean">
  Habilitar/desabilitar fila quando desconectado
</ParamField>

### Opcionais - apenas para criação de instâncias mobile

<ParamField body="profileName" type="string">
  Nome do perfil do WhatsApp
</ParamField>

<ParamField body="profilePictureUrl" type="string">
  URL referente a foto de perfil do WhatsApp
</ParamField>

***

## Request Body

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "name": "Minha instância"
}
```

***

## Response

### 200

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "id": "instanceId",
  "token": "instanceToken",
  "due": 1648565999675
}
```

### 405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

### 415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json".