> For the complete documentation index, see [llms.txt](https://ajuda.zdg.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.zdg.com.br/central-do-assinante/referencia-da-api/envio-em-lote.md).

# 📤 Envio Em Lote

## POST /v2/api/external/{ApiID}/bulkDispatch/incrementProgress/{dispatchId}

> BulkDispatchIncrementProgress

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkDispatch/incrementProgress/{dispatchId}":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchIncrementProgress","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"dispatchId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## GET /v2/api/external/{ApiID}/bulkDispatch/list

> BulkDispatchList

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkDispatch/list":{"get":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchList","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"limit","in":"query","schema":{"type":"integer"}},{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## GET /v2/api/external/{ApiID}/bulkDispatch/show/{dispatchId}

> BulkDispatchShow

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkDispatch/show/{dispatchId}":{"get":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchShow","parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"dispatchId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/bulkDispatch/update/{dispatchId}

> BulkDispatchUpdate

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkDispatch/update/{dispatchId}":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkDispatchUpdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"cancellationReason":{"type":"string"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true},{"name":"dispatchId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## BulkFastMessage

> v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkFastMessage":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkFastMessage","description":"v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie \"skipActiveTicketCheck\": false no body.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"whatsappType":{"type":"string"},"arrayNumbers":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /v2/api/external/{ApiID}/bulkIndividual

> BulkIndividual

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkIndividual":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkIndividual","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"number":{"type":"string"},"message":{"type":"string"},"externalKey":{"type":"string"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## BulkSendMessage

> v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkSendMessage":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkSendMessage","description":"v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie \"skipActiveTicketCheck\": false no body.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"arrayNumbers":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## BulkSendMessageWithVariable

> v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, o destinatario com ticket aberto ou pendente (em qualquer canal) NAO recebe o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

```json
{"openapi":"3.0.0","info":{"title":"Z-PRO v4.x.x.x","version":"1.0.0"},"tags":[{"name":"📤 Envio em Lote"}],"servers":[{"url":"https://{{BaseUrl}}"},{"url":"undefined://{{BASE_URL}}"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v2/api/external/{ApiID}/bulkSendMessageWithVariable":{"post":{"tags":["📤 Envio em Lote"],"summary":"BulkSendMessageWithVariable","description":"v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, o destinatario com ticket aberto ou pendente (em qualquer canal) NAO recebe o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie \"skipActiveTicketCheck\": false no body.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"whatsappId":{"type":"string"},"message":{"type":"string"},"dataInput":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"}}}}}},"parameters":[{"name":"ApiID","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.zdg.com.br/central-do-assinante/referencia-da-api/envio-em-lote.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.