> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Dados do QR code por tipo

> O formato dos dados, um exemplo de requisição e o que pode ser editado após a impressão em cada um dos 16 tipos de QR code.

> [!NOTE]
>
> A API do GetQR está em beta e disponível para workspaces selecionados. Os detalhes podem mudar antes do lançamento oficial.

Cada QR code tem um `qrType`, e o tipo define o que `data` deve conter. Este guia mostra o formato de cada tipo, um corpo de requisição que funciona e o que você ainda pode alterar depois que o código for impresso.

Os exemplos são corpos de requisição para [Criar um QR code](https://docs.getqr.com/pt-br/api/endpoints/qr-codes.md#criar-um-qr-code). Envie-os assim:

```bash theme={null}
curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "qrType": "website", "data": "https://example.com/menu", "title": "Menu" }'
```

## Todos os tipos em resumo

| `qrType` | `data` | Editável após a impressão |
| - | - | - |
| [`website`](#website) | URL http(s) | Sim |
| [`feedback`](#feedback) | URL http(s) do formulário | Sim |
| [`payment`](#pagamento) | URL do provedor de pagamento | Sim |
| [`whatsapp`](#whatsapp) | Link `wa.me` | Sim |
| [`location`](#localização) | URL de mapa | Sim |
| [`app`](#app-link) | URL da loja ou vazio, mais `link.ios` / `link.android` | Sim |
| [`email`](#e-mail) | URI `mailto:` | Sim |
| [`sms`](#sms) | URI `sms:` | Sim |
| [`wifi`](#wifi) | Payload `WIFI:` | **Não** |
| [`pdf`, `image`, `video`](#pdf-e-arquivos-de-imagem-ou-vídeo) | Vazio, com um `fileId` | Sim |
| [`vcard`](#vcard) | Texto vCard 3.0 | Sim |
| [`social`](#social-media) | String JSON | Sim |
| [`multilink`](#multi-link) | String JSON | Sim |
| [`event`](#evento) | String JSON | Sim |

## Como um QR code é resolvido

Todo QR code é um link curto mais um payload. Dois campos guardam o conteúdo:

| Campo | O que é |
| - | - |
| `link.url` | Para onde o link curto envia o visitante. É o destino real em todos os tipos, exceto `wifi`. |
| `data` | O payload do tipo, validado de acordo com `qrType`. Ele é armazenado como enviado apenas para `wifi`, `vcard`, `social`, `multilink`, `event` e `sms`. Nos outros tipos, ele só fornece o `link.url`, e o `data` armazenado passa a ser o link curto. Leia o destino em `url` na resposta. |

Regras para todos os tipos:

* **Padrões.** Na criação, um `link.url` omitido ou vazio passa a ser `data`, e você pode omitir o objeto `link` inteiro. Quando os dois são enviados e são diferentes, vale o `link.url`. Envie os dois iguais ou envie só `data`.
* **O que a imagem codifica.** A imagem codifica o link curto em todos os tipos, exceto `wifi`. Assim, você pode mudar para onde um código impresso leva, e as leituras dele são rastreadas. Um QR code de WiFi codifica a própria rede: não dá para alterá-lo depois de impresso, e as leituras dele não são rastreadas.
* **Esquemas.** `link.url` aceita apenas `http:`, `https:`, `wifi:`, `mailto:`, `sms:` e `begin:`. Qualquer outro, incluindo `geo:`, `smsto:`, `matmsg:` e `tel:`, recebe `422 Invalid destination URL`, mesmo quando `data` o aceita.
* **Dados vazios.** Um `data` vazio pula a validação do tipo. Em um tipo de redirecionamento, o `link.url` precisa estar definido, ou a chamada recebe `400 Missing destination URL`.
* **Estrutura.** Além da validação do tipo, o servidor não valida o payload. Um tipo JSON só precisa ser interpretável como um objeto JSON, e um vCard só precisa começar com `BEGIN:VCARD`.

> [!TIP]
>
> Os limites marcados com **Criador** abaixo são os que o editor do painel aplica. A API aceita payloads que os ignoram, mas eles podem aparecer de forma estranha na página de destino ou no editor.

## Website

`qrType`: `"website"`. Guia do painel: [QR code de Website](https://docs.getqr.com/pt-br/qr-types/website.md).

| Campo | Comportamento |
| - | - |
| `data` | Uma URL http(s). |
| `link.url` | O destino. Padrão: `data`. |
| `fileId` | Não permitido. |
| Codifica | O link curto, que redireciona para `link.url`. As leituras são rastreadas. |
| Após a impressão | Editável. Envie `data` ou `link.url` para mudar o destino. Só `data` já basta. |

```json Request body theme={null}
{
  "qrType": "website",
  "data": "https://example.com/menu",
  "title": "Menu"
}
```

Erros:

* `422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".`
* `422 Invalid destination URL`

## Feedback

`qrType`: `"feedback"`. Guia do painel: [QR code de Feedback](https://docs.getqr.com/pt-br/qr-types/feedback.md).

`data` é a URL http(s) do formulário de feedback, por exemplo um Google Form ou uma página de avaliações. Todo o resto funciona como em [Website](#website).

```json Request body theme={null}
{
  "qrType": "feedback",
  "data": "https://forms.gle/abc123"
}
```

## Pagamento

`qrType`: `"payment"`. Guia do painel: [QR code de Pagamento](https://docs.getqr.com/pt-br/qr-types/payment.md).

`data` é a URL de pagamento do provedor, por exemplo:

```text theme={null}
https://paypal.me/<user>/25EUR
```

O editor do painel reconhece estes hosts: `paypal.me`, `paypal.com/paypalme`, `cash.app`, `venmo.com`, `buy.stripe.com`, `stripe.com`, `square.link` e `payoneer.com`. No PayPal, o valor é o último segmento do caminho. Qualquer outra URL http(s) também funciona, mas o editor não a separa em provedor e valor. Todo o resto funciona como em [Website](#website).

```json Request body theme={null}
{
  "qrType": "payment",
  "data": "https://paypal.me/acme/25EUR"
}
```

## WhatsApp

`qrType`: `"whatsapp"`. Guia do painel: [QR code de WhatsApp](https://docs.getqr.com/pt-br/qr-types/whatsapp.md).

`data` é um link `wa.me`: o número internacional em dígitos, sem `+`, opcionalmente com um texto pré-preenchido.

```text theme={null}
https://wa.me/<digits>
https://wa.me/<digits>?text=<urlencoded>
```

O servidor só verifica se é uma URL http(s). O painel também lê links `api.whatsapp.com/send`. Todo o resto funciona como em [Website](#website).

```json Request body theme={null}
{
  "qrType": "whatsapp",
  "data": "https://wa.me/14155550123?text=Hi%20there"
}
```

## Localização

`qrType`: `"location"`. Guia do painel: [QR code de Localização](https://docs.getqr.com/pt-br/qr-types/location.md).

`data` é uma URL de mapa. Use este formato para manter o QR code editável no painel (`query_place_id` é opcional):

```text theme={null}
https://www.google.com/maps/search/?api=1&query=<address>&query_place_coords=<lat>,<lng>&query_place_id=<id>
```

Qualquer outra URL http(s) também redireciona. Um URI `geo:` passa na validação de `data`, mas é rejeitado como destino, então não o use. Todo o resto funciona como em [Website](#website).

```json Request body theme={null}
{
  "qrType": "location",
  "data": "https://www.google.com/maps/search/?api=1&query=Golden+Gate+Bridge&query_place_coords=37.8199,-122.4783"
}
```

## App Link

`qrType`: `"app"`. Guia do painel: [QR code de App Link](https://docs.getqr.com/pt-br/qr-types/app-link.md).

| Campo | Comportamento |
| - | - |
| `link.ios`, `link.android` | URLs da App Store e do Google Play. Visitantes no iOS vão para `ios`, e visitantes no Android para `android`. Eles prevalecem sobre todo o resto no momento da leitura. |
| `link.url` | O destino alternativo para outros dispositivos. Padrão: `data`, depois `ios` ou `android`. |
| `data` | Uma URL http(s) (o painel envia a URL da loja) ou vazio. Pelo menos um entre `link.ios`, `link.android`, `link.url` ou `data` precisa estar definido, ou a chamada recebe `400 Missing destination URL`. |
| `fileId` | Não permitido. |
| Codifica | O link curto. As leituras são rastreadas. |
| Após a impressão | Editável. `link.ios` e `link.android` são aplicados de forma independente, cada um só quando enviado. `null` limpa um deles. Você não precisa reenviar `qrType`. Mudar para outro tipo limpa os dois links de loja. |

```json Request body theme={null}
{
  "qrType": "app",
  "data": "https://apps.apple.com/app/id123456789",
  "link": {
    "ios": "https://apps.apple.com/app/id123456789",
    "android": "https://play.google.com/store/apps/details?id=com.acme.app"
  }
}
```

Erros:

* `422 Invalid URL`
* `400 Missing destination URL`

## E-mail

`qrType`: `"email"`. Guia do painel: [QR code de E-mail](https://docs.getqr.com/pt-br/qr-types/email.md).

```text theme={null}
mailto:<address>?subject=<subject>&body=<body>
```

| Campo | Comportamento |
| - | - |
| `data` | Um URI `mailto:` com assunto e corpo opcionais. Codifique os espaços como `%20`: o painel os grava como `+`, que nem todo app de e-mail interpreta como espaço. `matmsg:` é rejeitado como destino. |
| `link.url` | O URI `mailto:`. Padrão: `data`. |
| `fileId` | Não permitido. |
| Codifica | O link curto, que abre uma página que repassa para o app de e-mail. |
| Após a impressão | Editável. Envie `data` ou `link.url` para mudar a mensagem. Só `data` já basta. |

```json Request body theme={null}
{
  "qrType": "email",
  "data": "mailto:hi@example.com?subject=Hello&body=Hi%20there"
}
```

Erros:

* `422 Expected a mailto URI, e.g. "mailto:hi@example.com?subject=Hello" for qrType "email".`

## SMS

`qrType`: `"sms"`. Guia do painel: [QR code de SMS](https://docs.getqr.com/pt-br/qr-types/sms.md).

```text theme={null}
sms:+<digits>
sms:+<digits>?body=<encodeURIComponent(text)>
```

| Campo | Comportamento |
| - | - |
| `data` | Um URI `sms:` com corpo opcional. O painel lê apenas exatamente este formato. `smsto:` é rejeitado como destino. |
| `link.url` | O URI `sms:`. Padrão: `data`. |
| `fileId` | Não permitido. |
| Codifica | O link curto, que abre uma página que repassa para o app de mensagens. |
| Após a impressão | Editável. Envie `data` ou `link.url` para mudar a mensagem. Só `data` já basta. |

```json Request body theme={null}
{
  "qrType": "sms",
  "data": "sms:+14155550123?body=Table%2012"
}
```

Erros:

* `422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".`

## WiFi

`qrType`: `"wifi"`. Guia do painel: [QR code de WiFi](https://docs.getqr.com/pt-br/qr-types/wifi.md).

```text theme={null}
WIFI:T:<WPA|WEP|nopass>;S:<ssid>;P:<password>;H:<true|false>;;
```

| Campo | Comportamento |
| - | - |
| `data` | Obrigatório. Mantenha a ordem `T`, `S`, `P`, `H`: o editor e a lista do painel dependem dela. Escape `\`, `;`, `"` e `:` no SSID e na senha com uma barra invertida. Para uma rede aberta, use `T:nopass` com um `P:` vazio. Os leitores rejeitam `T:none`. **Criador:** SSID obrigatório, senha com pelo menos 8 caracteres, exceto com `nopass`. |
| `link.url` | Não é usado na leitura. Padrão: `data`. |
| `fileId` | Não permitido. |
| Codifica | O payload `WIFI:` bruto, não o link curto. As leituras não são rastreadas. |
| Após a impressão | **Não editável.** Um novo `data` só muda os downloads futuros. Os códigos impressos mantêm a rede antiga. |

```json Request body theme={null}
{
  "qrType": "wifi",
  "data": "WIFI:T:WPA;S:Cafe Guest;P:espresso42;H:false;;"
}
```

Erros:

* `422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".`

> [!WARNING]
>
> Não mude o tipo de um QR code de WiFi já impresso. Os códigos impressos mantêm a rede antiga.

## PDF e arquivos de imagem ou vídeo

`qrType`: `"pdf"`, `"image"` ou `"video"`. Guias do painel: [PDF](https://docs.getqr.com/pt-br/qr-types/pdf.md), [Image](https://docs.getqr.com/pt-br/qr-types/image.md), [Video](https://docs.getqr.com/pt-br/qr-types/video.md).

| Campo | Comportamento |
| - | - |
| `fileId` | O arquivo. Envie-o com o target correspondente ao tipo: `pdf`, `image` ou `video`. Com um `fileId`, o `link.url` passa a ser a URL do arquivo, e qualquer valor enviado nele é ignorado. |
| `data` | Qualquer coisa, exceto o payload de outro tipo (`WIFI:`, `BEGIN:VCARD`, `sms:`, `mailto:`, um objeto JSON). Vazio também serve. |
| `link.url` | Sem um `fileId`, o `link.url` (ou `data`) é usado como destino externo. Isso funciona, mas o painel não mostra nenhum arquivo. |
| Codifica | O link curto, que redireciona direto para o arquivo. Um PDF abre como o arquivo bruto, não em uma página de visualização. |
| Após a impressão | Editável. Envie um novo `fileId` para substituir o arquivo. O antigo é liberado. |

Um arquivo por QR code: pacotes de PDFs e galerias de imagens não estão disponíveis na API. Veja [Não suportado pela API](#não-suportado-pela-api).

```json pdf theme={null}
{
  "qrType": "pdf",
  "data": "",
  "fileId": "file_9f8e7d6c5b4a",
  "title": "Brochure"
}
```

```json image theme={null}
{
  "qrType": "image",
  "data": "",
  "fileId": "file_3c2b1a0f9e8d",
  "title": "Floor plan"
}
```

```json video theme={null}
{
  "qrType": "video",
  "data": "",
  "fileId": "file_5e4d3c2b1a0f",
  "title": "Product demo"
}
```

Para enviar o arquivo e obter o `fileId` dele, veja [Arquivos](https://docs.getqr.com/pt-br/api/endpoints/files.md).

## vCard

`qrType`: `"vcard"`. Guia do painel: [QR code de vCard](https://docs.getqr.com/pt-br/qr-types/vcard.md).

| Campo | Comportamento |
| - | - |
| `data` | Obrigatório. Texto vCard 3.0 que começa com `BEGIN:VCARD`, com linhas separadas por `\r\n` (`\n` também funciona). |
| `fileId` | Imagem de perfil opcional (target `logo`), usada quando `data` não tem uma linha `PHOTO` ou `X-GETQR-IMAGE-FILEID`. |
| `link.url` | Ignorado e substituído pela página hospedada. Omita. |
| Codifica | O link curto, que abre a página de contato hospedada com um download para salvar o contato (`.vcf`). |
| Após a impressão | Editável. Envie um novo `data` para atualizar a página. |

A página de destino e o editor leem apenas os formatos de linha abaixo. Outras variantes, como `TEL;CELL:` ou `EMAIL;TYPE=INTERNET:`, são armazenadas, mas não aparecem na página.

* `N:<last>;<first>;;;`: sobrenome e nome. **Criador:** ambos obrigatórios, até 40 caracteres.
* `FN:<first> <last>`: não é lido pela página. O rótulo na lista do painel vem daqui.
* `ORG:<company>` e `TITLE:<role>`: empresa e cargo. **Criador:** até 40 caracteres.
* `TEL;TYPE=HOME:`, `TEL;TYPE=CELL:`, `TEL;TYPE=WORK:`, `TEL;TYPE=FAX:`: números de telefone, celular, trabalho e fax (`+` e dígitos).
* `EMAIL:<email>`: endereço de e-mail.
* `URL:<url>`: site.
* `NOTE:<text>`: resumo. Escape `\\`, `\n`, `\;` e `\,`. **Criador:** até 200 caracteres.
* `ADR:;;<street>;<city>;<state>;<zip>;<country>`: endereço.
* `X-SOCIALPROFILE;TYPE=<platform>:<url>` ou `URL;TYPE=<PLATFORM>:<url>`: links de redes sociais, uma linha por plataforma.
* `PHOTO;VALUE=URI:<url>`: URL da imagem de perfil. Prevalece sobre qualquer ID de arquivo.
* `X-GETQR-IMAGE-FILEID:<fileId>`: imagem de perfil (target `logo`).
* `X-GETQR-PAGE-LOGO-FILEID:<fileId>`: logo da página (target `logo`).
* `X-GETQR-LANDING-THEME:p|<0-4>` ou `X-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB`: tema da página de destino, seja um índice predefinido (de 0 a 4), seja cores personalizadas de fundo, botão e ícone.

Plataformas sociais: `facebook`, `whatsapp`, `instagram`, `youtube`, `tiktok`, `messenger`, `snapchat`, `linkedin`, `x`, `reddit`, `pinterest`, `telegram`, `wechat`, `viber`, `line`.

```json Request body theme={null}
{
  "qrType": "vcard",
  "data": "BEGIN:VCARD\r\nVERSION:3.0\r\nN:Doe;Jane;;;\r\nFN:Jane Doe\r\nORG:Acme\r\nTITLE:CTO\r\nTEL;TYPE=CELL:+14155550123\r\nEMAIL:jane@acme.com\r\nURL:https://acme.com\r\nX-GETQR-LANDING-THEME:p|0\r\nEND:VCARD",
  "title": "Jane Doe"
}
```

Erros:

* `422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".`

## Social Media

`qrType`: `"social"`. Guia do painel: [QR code de Social Media](https://docs.getqr.com/pt-br/qr-types/social.md).

| Campo | Comportamento |
| - | - |
| `data` | Obrigatório. Uma string JSON que codifica um objeto. Monte-a com `JSON.stringify`. |
| `fileId` | Imagem de perfil opcional no nível superior (target `logo`). |
| `link.url` | Ignorado e substituído pela página hospedada. Omita. |
| Codifica | O link curto, que abre a página social hospedada. |
| Após a impressão | Editável. Envie um novo `data` para atualizar a página. |

Campos em `data`:

| Campo | Tipo | Observações |
| - | - | - |
| `firstName` | string | Título da página e único nome exibido. **Criador:** obrigatório, até 40. |
| `lastName` | string | Até 40. Não é exibido na página. |
| `summary` | string | Até 200. |
| `socialLinks` | `{ platform, url }[]` | `platform` é uma das [plataformas sociais do vCard](#vcard). **Criador:** cada plataforma uma única vez. |
| `customItems` | `{ name, url, logoFileId }[]` | **Criador:** `name` com até 40, uma `url` http(s) e um `logoFileId`. No total, pelo menos um link social ou item personalizado. |
| `fileId` | string | Imagem de perfil (target `logo`). O `fileId` do nível superior é a alternativa. |
| `imageUrl` | string | URL externa da imagem de perfil, usada só quando não há ID de arquivo. |
| `pageLogoFileId` | string | Logo da página (target `logo`). |
| `landingThemeMode` | `"preset" \| "custom"` | Padrão: `preset`. |
| `landingPresetIndex` | 0–4 | Padrão: 0. |
| `landingCustomBg`, `landingCustomButton`, `landingCustomIcon` | `#RRGGBB` | Usados quando o modo é `custom`. |

```json Request body theme={null}
{
  "qrType": "social",
  "data": "{\"firstName\":\"Acme Coffee\",\"summary\":\"Follow us\",\"socialLinks\":[{\"platform\":\"instagram\",\"url\":\"https://instagram.com/acme\"}],\"customItems\":[]}"
}
```

Erros:

* `422 Expected a JSON object describing the social profile page for qrType "social".`

## Multi-Link

`qrType`: `"multilink"`. Guia do painel: [QR code de Multi-Link](https://docs.getqr.com/pt-br/qr-types/multi-link.md).

| Campo | Comportamento |
| - | - |
| `data` | Obrigatório. Uma string JSON que codifica um objeto. |
| `fileId` | Imagem de perfil opcional no nível superior (target `logo`). |
| `link.url` | Ignorado e substituído pela página hospedada. Omita. |
| Codifica | O link curto, que abre a página multi-link hospedada. |
| Após a impressão | Editável. Envie um novo `data` para atualizar a página. |

Os campos em `data` são os de [Social Media](#social-media), exceto que `firstName`, `lastName` e `summary` são substituídos por:

| Campo | Tipo | Observações |
| - | - | - |
| `title` | string | Título da página. **Criador:** obrigatório, até 40. |
| `description` | string | Até 200. |

Em `customItems`, `logoFileId` é opcional: um ícone padrão é exibido. **Criador:** pelo menos um link social ou um item personalizado não vazio.

```json Request body theme={null}
{
  "qrType": "multilink",
  "data": "{\"title\":\"Acme links\",\"description\":\"Everything in one place\",\"socialLinks\":[],\"customItems\":[{\"name\":\"Shop\",\"url\":\"https://acme.com/shop\",\"logoFileId\":\"\"}]}"
}
```

Erros:

* `422 Expected a JSON object describing the multi-link page for qrType "multilink".`

## Evento

`qrType`: `"event"`. Guia do painel: [QR code de Evento](https://docs.getqr.com/pt-br/qr-types/event.md).

| Campo | Comportamento |
| - | - |
| `data` | Obrigatório. Uma string JSON que codifica um objeto. Valores desconhecidos ou inválidos voltam aos padrões. |
| `fileId` | Validado (target `logo`) e armazenado, mas a página do evento lê a capa apenas de `data.fileId`. Coloque o ID da capa no payload. |
| `link.url` | Ignorado e substituído pela página hospedada. Omita. |
| Codifica | O link curto, que abre a página do evento hospedada com um download `.ics`. |
| Após a impressão | Editável. Envie um novo `data` para atualizar a página. |

Campos em `data`:

| Campo | Tipo | Observações |
| - | - | - |
| `name` | string | **Criador:** obrigatório. |
| `eventType` | string | Um dos tipos de evento abaixo, ou vazio. |
| `start`, `end` | `"YYYY-MM-DDTHH:mm"` | Horário local em `timezone`. **Criador:** ambos obrigatórios, fim depois do início. |
| `timezone` | IANA, por exemplo `"Europe/Berlin"` | Posiciona o início e o fim no arquivo `.ics`. Envie sempre: com um fuso vazio ou desconhecido, o `.ics` trata os horários como UTC. |
| `street`, `zip`, `city`, `state`, `country` | string | **Criador:** `city` e `country` obrigatórios, até 40 cada. |
| `facilities` | string\[] | IDs da lista abaixo. IDs desconhecidos são descartados. |
| `notes` | string | Texto livre. |
| `fileId` | string | Imagem de capa (target `logo`). |
| `pageLogoFileId` | string | Logo da página (target `logo`). |
| `organizerName`, `organizerEmail`, `mobile`, `work` | string | `mobile` e `work` até 40. |
| `socialLinks` | `{ platform, url }[]` | As [plataformas sociais do vCard](#vcard), mais `website`. |
| `ticketsUrl` | URL http(s) | Link para comprar ingressos. |
| `ticketsLabel` | string | Até 20 caracteres. Rótulos mais longos são cortados. Vazio exibe o rótulo padrão. |

> [accordion] Tipos de evento
>
> `conference`, `seminar`, `workshop`, `training`, `webinar`, `meetup`, `networking`, `corporateEvent`, `productLaunch`, `tradeShow`, `jobFair`, `fundraiser`, `charity`, `wedding`, `engagement`, `birthday`, `anniversary`, `babyShower`, `graduation`, `reunion`, `party`, `religious`, `funeralMemorial`, `ceremony`, `concert`, `festival`, `clubNight`, `theater`, `comedy`, `filmScreening`, `exhibition`, `sports`, `tournament`, `raceMarathon`, `fitnessClass`, `foodDrink`, `market`, `openHouse`, `community`, `schoolEvent`, `kids`, `travelTour`

> [accordion] Comodidades
>
> | Grupo | IDs |
> | - | - |
> | Entrada | `freeEntry`, `idRequired`, `invitationOnly`, `plusOneAllowed`, `reEntryAllowed` |
> | Idade (escolha um) | `adultsOnly`, `age18Plus`, `age21Plus`, `kidsWelcome` |
> | No local | `parking`, `publicTransport`, `shuttle`, `wheelchairAccess`, `evCharging`, `wifi`, `foodDrinks`, `alcoholServed`, `atm`, `coatCheck`, `pool`, `phoneCharging`, `firstAid`, `wc` |
> | Regras | `petsAllowed`, `noPets`, `smokingArea`, `noSmoking`, `noPhotos` |
> | Traje (escolha um) | `dressCasual`, `dressSmartCasual`, `dressBusiness`, `dressCocktail`, `dressThemed` |

```json Request body theme={null}
{
  "qrType": "event",
  "data": "{\"name\":\"Launch party\",\"eventType\":\"productLaunch\",\"start\":\"2026-11-20T18:00\",\"end\":\"2026-11-20T22:00\",\"timezone\":\"Europe/Berlin\",\"city\":\"Berlin\",\"country\":\"Germany\",\"facilities\":[\"freeEntry\"],\"socialLinks\":[],\"ticketsUrl\":\"https://acme.com/tickets\"}"
}
```

Erros:

* `422 Expected a JSON object describing the event page for qrType "event".`

## Arquivos em QR codes

Registre um arquivo com [Arquivos](https://docs.getqr.com/pt-br/api/endpoints/files.md), envie-o e depois passe o `fileId` dele. Use o target que corresponde ao uso:

* **`pdf`, `image`, `video`.** O conteúdo de um QR code de PDF, Image ou Video.
* **`logo`.** Imagens de perfil, logos de página, ícones de links personalizados e logos centrais.

Arquivos que nunca são anexados a um QR code são excluídos após um período de carência.

Erros de `fileId`, retornados na criação e no `PATCH` quando `fileId` é enviado:

| Status | Causa |
| - | - |
| `422 unprocessable_entity` | O tipo não aceita arquivo. Apenas `pdf`, `image`, `video`, `vcard`, `social`, `multilink` e `event` aceitam. |
| `404 not_found` | Não há arquivo com este ID. Registre-o antes com `POST /api/v1/files`. |
| `422 unprocessable_entity` | O arquivo foi enviado para outro target. Por exemplo, um upload `image` em um QR code de PDF, ou um upload `pdf`, `image` ou `video` usado como foto de vCard. |
| `422 unprocessable_entity` | O arquivo está registrado, mas o upload para `uploadUrl` nunca foi concluído. |

IDs de arquivo dentro de um payload (`fileId`, `pageLogoFileId`, `customItems[].logoFileId`, linhas `X-GETQR-*-FILEID`) não são validados. Eles só são exibidos quando enviados com o target `logo`. O QR code passa a ser dono deles, então a limpeza não os remove.

## Mudança de tipo

Você pode alterar o `qrType` com [Atualizar um QR code](https://docs.getqr.com/pt-br/api/endpoints/qr-codes.md#atualizar-um-qr-code). Envie um `data` compatível com o novo tipo: o payload armazenado pertence ao tipo antigo, então uma mudança sem ele é rejeitada.

Depois de uma atualização, o destino é resolvido nesta ordem:

1. `vcard`, `social`, `multilink`, `event`: sempre a página hospedada.
2. Um pacote de PDFs ou uma galeria de imagens criados no painel: a página de destino deles.
3. `pdf`, `image`, `video`: a URL do arquivo (um novo `fileId` ou, se não houver, o armazenado).
4. `link.url`, quando enviado.
5. O `data` alterado.
6. A URL armazenada.

O que cada mudança faz:

* **Saindo de `pdf`, `image` ou `video`.** O `fileId` e qualquer pacote ou galeria são limpos.
* **Entrando em `pdf`, `image` ou `video`.** Envie também o `fileId`, ou o armazenado é reaproveitado, e ele pode ser uma foto de vCard.
* **Saindo de `app`.** O nome do app, `link.ios` e `link.android` são limpos, então os celulares seguem o novo destino.
* **Entrando em `wifi`.** A imagem passa a codificar o payload bruto. Os códigos já impressos continuam com o link curto, que agora redireciona para uma URL `wifi:`.
* **Saindo de `wifi`.** Os códigos impressos mantêm a rede antiga.
* **Entrando em `vcard`, `social`, `multilink` ou `event`.** O link curto passa a apontar para a nova página hospedada.
* **Saindo de `vcard`, `social`, `multilink` ou `event`.** Envie o novo `data`. O destino o acompanha.

QR codes estáticos criados no painel não têm link curto, então alterar o `link.url` deles retorna `422`.

## Não suportado pela API

Estes recursos do painel não fazem parte da API v1. Campos desconhecidos são descartados sem erro, então enviá-los não tem efeito.

| Campo | Descrição |
| - | - |
| `appName` | O nome de exibição de um QR code de App Link. QR codes de App Link criados pela API mostram a URL da loja na lista do painel. |
| `isStatic` | Um QR code estático, sem link curto. Todo QR code criado pela API tem um, então pode ser editado e rastreado depois de impresso (exceto `wifi`). |
| `pdfBundle` | Um QR code de PDF com dois ou mais arquivos. A API cria apenas QR codes de PDF com um único arquivo. |
| `imageGallery` | Um QR code de Image com duas ou mais imagens. A API cria apenas QR codes com uma única imagem. |

Pacotes e galerias criados no painel ainda podem ser lidos, pausados e excluídos pela API, mas os arquivos deles não podem ser alterados por ela.

## Problemas comuns

> [accordion] 422 Invalid destination URL
>
> O `link.url` usa um esquema para o qual o link curto não consegue redirecionar, como `geo:`, `smsto:`, `matmsg:` ou `tel:`. Use os formatos desta página.

> [accordion] 400 Missing destination URL
>
> `data` está vazio e não há `link.url`. Para `app`, defina pelo menos um entre `link.ios`, `link.android`, `link.url` ou `data`.

> [accordion] O data da resposta é um link curto, não a minha URL
>
> Nos tipos de link, o `data` armazenado é o link curto. Leia o destino em `url`.

> [accordion] A página de destino não mostra detalhes do meu payload
>
> A página lê apenas os campos e formatos de linha listados para o tipo. Outros campos são armazenados, mas não exibidos.

## Próximos passos

> [card] [QR codes](https://docs.getqr.com/pt-br/api/endpoints/qr-codes.md)

> [card] [Arquivos](https://docs.getqr.com/pt-br/api/endpoints/files.md)

> [card] [Personalização](https://docs.getqr.com/pt-br/api/guides/customization.md)

> [card] [Regras de acesso](https://docs.getqr.com/pt-br/api/guides/access-rules.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.