> ## 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.

# Obter link de convite

> Obtém o link de convite de um grupo

## Conceituação

Este método permite que você obtenha o link de convite de um grupo.

***

## Atributos

### Header

<ParamField path="instanceId" type="string" required>
  ID da sua instância. Disponível no painel Z-API em **Instâncias**.
</ParamField>

<ParamField path="token" type="string" required>
  Token da sua instância Z-API.
</ParamField>

### Path

<ParamField path="groupId" type="string" required>
  ID/Phone do grupo
</ParamField>

***

## Response

### 200

<ResponseField name="phone" type="string">
  ID/Phone do grupo
</ResponseField>

<ResponseField name="invitationLink" type="string">
  Link de convite do grupo
</ResponseField>

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "phone": "120363019502650977-group",
  "invitationLink": "https://chat.whatsapp.com/C1adgkdEGki7554BWDdMkd"
}
```

### 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".
