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

# Executar ação da Z-API (DELETE)

> Repassa a chamada para a [API da Z-API](https://developer.z-api.io) usando a instância do canal no GPT Maker. Use para recursos da Z-API que a API do GPT Maker ainda não expõe, como lista de opções (`send-option-list`) e botões (`send-button-list`).

- `action` é o caminho da rota na Z-API depois de `/instances/{instância}/token/{token}/`, por exemplo `send-option-list`. Pode ter mais de um trecho, como `chats/5511999999999`.
- O corpo e a query string vão para a Z-API como foram enviados, e a resposta é a da Z-API.
- Funciona só para canais Z-API.
- Envios (rotas `send-*`) exigem `phone` no corpo.
- Mensagens enviadas por aqui aparecem no chat do GPT Maker e não acionam o agente.
- Rotas bloqueadas: alteração de webhooks (`update-webhook-*` e `update-every-webhooks`) e `me`.

**Erros**

| Status | Quando |
| --- | --- |
| `404` | Canal inexistente, de outra conta ou que não é Z-API, rota bloqueada ou caminho inválido. |
| `400` | Envio (`send-*`) sem `phone` no corpo. |
| `502` | A Z-API não respondeu. |

Os demais erros vêm da Z-API, com o status e o corpo dela.



## OpenAPI

````yaml DELETE /v2/channel/{channelId}/whatsapp/{action}
openapi: 3.0.1
info:
  title: OpenAPI GPT Maker
  description: Documentação completa da API do GPT Maker
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.gptmaker.ai
security:
  - bearerAuth: []
paths:
  /v2/channel/{channelId}/whatsapp/{action}:
    delete:
      summary: Executar ação da Z-API (DELETE)
      description: >-
        Repassa a chamada para a [API da Z-API](https://developer.z-api.io)
        usando a instância do canal no GPT Maker. Use para recursos da Z-API que
        a API do GPT Maker ainda não expõe, como lista de opções
        (`send-option-list`) e botões (`send-button-list`).


        - `action` é o caminho da rota na Z-API depois de
        `/instances/{instância}/token/{token}/`, por exemplo `send-option-list`.
        Pode ter mais de um trecho, como `chats/5511999999999`.

        - O corpo e a query string vão para a Z-API como foram enviados, e a
        resposta é a da Z-API.

        - Funciona só para canais Z-API.

        - Envios (rotas `send-*`) exigem `phone` no corpo.

        - Mensagens enviadas por aqui aparecem no chat do GPT Maker e não
        acionam o agente.

        - Rotas bloqueadas: alteração de webhooks (`update-webhook-*` e
        `update-every-webhooks`) e `me`.


        **Erros**


        | Status | Quando |

        | --- | --- |

        | `404` | Canal inexistente, de outra conta ou que não é Z-API, rota
        bloqueada ou caminho inválido. |

        | `400` | Envio (`send-*`) sem `phone` no corpo. |

        | `502` | A Z-API não respondeu. |


        Os demais erros vêm da Z-API, com o status e o corpo dela.
      parameters:
        - name: channelId
          in: path
          description: ID do canal Z-API
          required: true
          schema:
            type: string
        - name: action
          in: path
          description: Rota da Z-API, por exemplo `send-option-list`
          required: true
          schema:
            type: string
          example: send-option-list
      responses:
        '200':
          description: Resposta da Z-API
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                zaapId: 3999984263738042930CD6ECDE9VDWSA
                messageId: D241XXXX732339502B68
                id: D241XXXX732339502B68
        '400':
          description: Envio sem telefone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
              example:
                error: phone is required
        '403':
          description: Erro de token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Canal ou rota não encontrados
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
              example:
                error: not found
        '502':
          description: Z-API indisponível
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
              example:
                error: z-api unavailable
components:
  schemas:
    RequestError:
      required:
        - error
      type: object
      properties:
        error:
          type: string
          description: Motivo do erro.
        errorCode:
          type: string
          description: Presente quando o arquivo em base64 é recusado.
          enum:
            - INVALID_BASE64
            - UNSUPPORTED_MEDIA_TYPE
            - MEDIA_TOO_LARGE
            - IMAGE_TOO_LARGE
    Error403:
      required:
        - error
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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