docs.json

{
  "$schema": "https://mintlify.com/schema.json",
  "theme": "mint",
  "name": "Z-API Docs",
  "logo": {
    "light": "https://staging.z-api.io/logos/SVG/Ativo%2016.svg",
    "dark": "https://staging.z-api.io/logos/SVG/Ativo%2016.svg"
  },
  "favicon": "/favicon.png",
  "styling": {
    "codeblocks": {
      "theme": {
        "dark": "poimandres",
        "light": "github-light"
      }
    }
  },
  "background": {
    "color": {
      "dark": "#14161f"
    }
  },
  "colors": {
    "primary": "#00B140",
    "light": "#00D455",
    "dark": "#007A2C"
  },
    "api": {
    "mdx": {
      "server": "https://api.z-api.io",
      "auth": {
        "method": "key",
        "name": "Client-Token"
      }
    },
    "examples": {
      "defaults": "required"
    }
  },
  "navigation": {
    "global": {
      "anchors": [
        { "anchor": "Blog", "icon": "newspaper", "href": "https://www.z-api.io/blog" },
        { "anchor": "YouTube", "icon": "youtube", "href": "https://www.youtube.com/@z_api" },
        { "anchor": "Postman", "icon": "rocket", "href": "https://www.postman.com/docs-z-api/z-api-s-public-workspace/collection/gwri249/z-api-collection" },
        { "anchor": "WhatsApp", "icon": "whatsapp", "href": "https://chat.whatsapp.com/KmE3atZGmWJEspMZnBZKjV" }
      ]
    },
    "languages": [
      {
        "language": "pt-BR",
        "default": true,
        "navbar": {
          "links": [
            {
              "label": "Suporte",
              "href": "https://api.whatsapp.com/send?phone=554431421722&text=Ol%C3%A1,%20gostaria%20de%20falar%20com%20o%20suporte%20da%20Z-API"
            }
          ],
          "primary": {
            "type": "button",
            "label": "Painel",
            "href": "https://app.z-api.io/"
          }
        },
        "tabs": [
          {
            "tab": "Documentação",
            "groups": [
              {
                "group": "Início",
                "pages": ["quickstart/introduction"]
              },
              {
                "group": "Segurança",
                "pages": ["security/introduction", "security/ip-block", "security/twofactor", "security/client-token"]
              },
              {
                "group": "Dicas",
                "pages": [
                  "tips/blockednumber",
                  "tips/blockednumbernew",
                  "tips/lid",
                  "tips/enable-fix-number",
                  "tips/emulators",
                  "tips/Z-APIvsAPI-OFICIAL",
                  "tips/button-status",
                  "tips/file-expiration",
                  "tips/postman-collection"
                ]
              }
            ]
          },
          {
            "tab": "API Reference",
            "groups": [
              {
                "group": "Visão Geral",
                "pages": ["api-reference/introduction"]
              },
              {
                "group": "API Reference",
                "pages": [
                  { "group": "Instance",          "pages": ["instance/introduction", "instance/update-auto-read-message", "instance/update-auto-read-status", "instance/profile-picture", "instance/profile-name", "instance/profile-description", "instance/update-call-reject-auto", "instance/update-call-reject-message", "instance/qrcode", "instance/qr-code", "instance/qr-code-image", "instance/phone-code", "instance/restart", "instance/disconnect", "instance/status", "instance/device", "instance/rename-instance", "instance/me"] },
                  { "group": "Mobile",            "pages": ["mobile/introduction", "mobile/registration-available", "mobile/request-code", "mobile/captcha-confirm", "mobile/confirm-code", "mobile/request-unbanning", "mobile/confirm-security-code", "mobile/forgot-security-code", "mobile/get-account-email", "mobile/set-account-email", "mobile/verify-account-email", "mobile/get-has-security-code", "mobile/set-security-code", "mobile/remove-account-email", "mobile/remove-security-code"] },
                  { "group": "Messages",          "pages": ["message/introduction", "message/send-text", "message/forward-message", "message/send-message-reaction", "message/send-remove-reaction", "message/send-message-image", "message/send-message-sticker", "message/send-message-gif", "message/send-message-audio", "message/send-message-video", "message/send-message-ptv", "message/send-message-document", "message/send-message-link", "message/send-message-location", "message/send-message-product", "message/send-message-catalog", "message/send-message-contact", "message/send-message-multiple-contacts", "message/send-button-actions", "message/send-button-list", "message/send-button-list-image", "message/send-button-list-video", "message/send-option-list", "message/send-button-otp", "message/send-button-pix", "message/send-carousel", "message/delete-message", "message/read-message", "message/reply-message", "message/send-poll", "message/send-poll-vote", "message/send-message-order", "message/send-order-status-update", "message/send-order-payment-update", "message/send-pin-message", "message/send-newsletter-admin-invite", "message/send-event", "message/send-edit-event", "message/send-event-response"] },
                  { "group": "Privacy",           "pages": ["privacy/introduction", "privacy/get-disallowed-contacts", "privacy/set-last-seen", "privacy/set-photo-visualization", "privacy/set-privacy-description", "privacy/set-group-add-permission", "privacy/set-privacy-online", "privacy/set-read-receipts", "privacy/set-messages-duration"] },
                  { "group": "Contacts",          "pages": ["contacts/introduction", "contacts/get-contacts", "contacts/add-contacts", "contacts/remove-contacts", "contacts/get-metadata-contact", "contacts/get-profile-picture", "contacts/get-iswhatsapp", "contacts/get-iswhatsapp-batch", "contacts/block-contact", "contacts/report-contact"] },
                  { "group": "Chats",             "pages": ["chats/introduction", "chats/get-chats", "chats/get-metadata-chat", "chats/read-chat", "chats/archive-chat", "chats/pin-chat", "chats/mute-chat", "chats/clear-chat", "chats/delete-chat", "chats/send-chat-expiration"] },
                  { "group": "Calls",             "pages": ["calls/introduction", "calls/send-call", "calls/call-token", "calls/sip-token", "calls/sip-info"] },
                  { "group": "Groups",            "pages": ["group/introduction", "group/get-groups", "group/create-group", "group/update-group-name", "group/update-group-photo", "group/add-participant", "group/remove-participant", "group/approve-participant", "group/reject-participant", "group/mention-participant", "group/mention-group", "group/add-admin", "group/remove-admin", "group/leave-group", "group/metadata-group", "group/light-group-metadata", "group/group-invitation-metadata", "group/update-group-settings", "group/update-group-description", "group/redefine-invitation-link", "group/get-invitation-link", "group/accept-group-invite"] },
                  { "group": "Communities",       "pages": ["communities/introduction", "communities/create-community", "communities/list-communities", "communities/link-groups", "communities/unlink-groups", "communities/community-metadata", "communities/redefine-invitation-link", "communities/add-community-participant", "communities/remove-community-participant", "communities/add-community-admin", "communities/remove-community-admin", "communities/community-settings", "communities/deactivate-community", "communities/update-community-description"] },
                  { "group": "Meta AI",           "pages": ["metaai/introduction", "metaai/conversation"] },
                  { "group": "Newsletter",        "pages": ["newsletter/introduction", "newsletter/create-newsletter", "newsletter/update-newsletter-picture", "newsletter/update-newsletter-name", "newsletter/update-newsletter-description", "newsletter/follow-newsletter", "newsletter/unfollow-newsletter", "newsletter/mute-newsletter", "newsletter/unmute-newsletter", "newsletter/delete-newsletter", "newsletter/newsletter-metadata", "newsletter/newsletter-list", "newsletter/search-newsletter", "newsletter/update-newsletter-config", "newsletter/accept-newsletter-admin-invite", "newsletter/newsletter-remove-admin", "newsletter/newsletter-revoke-admin-invite", "newsletter/transfer-newsletter-ownership"] },
                  { "group": "Transmission List", "pages": ["broadcast/introduction"] },
                  { "group": "Status",            "pages": ["status/introduction", "status/send-text-status", "status/send-image-status", "status/send-video-status", "status/reply-status-text", "status/reply-status-gif", "status/reply-status-sticker"] },
                  { "group": "Message Queue",     "pages": ["queue/introduction", "queue/get-queue", "queue/post-queue", "queue/delete-queue", "queue/delete-queue-id"] },
                  { "group": "WhatsApp Business", "pages": ["business/introduction", "business/edit-product", "business/get-products", "business/get-products-phone", "business/get-products-v2", "business/get-products-phone-v2", "business/get-product-id", "business/delete-product", "business/tags", "business/tags-colors", "business/create-tag", "business/edit-tag", "business/delete-tag", "business/tags-add", "business/tags-remove", "business/chats-notes", "business/save-catalog-config", "business/create-collection", "business/list-collections", "business/delete-collection", "business/edit-collection", "business/list-collection-products", "business/add-product-to-collection", "business/remove-product-from-collection", "business/company-description", "business/company-email", "business/company-address", "business/company-websites", "business/business-hours", "business/available-categories", "business/company-categories", "business/profile"] },
                  { "group": "Webhooks",          "pages": ["webhooks/introduction", "webhooks/on-message-send", "webhooks/on-message-received", "webhooks/on-message-received-examples", "webhooks/on-whatsapp-disconnected", "webhooks/on-whatsapp-message-status-changes", "webhooks/on-chat-presence", "webhooks/on-chat-presence-examples", "webhooks/on-webhook-connected", "webhooks/update-every-webhooks", "webhooks/update-notify-sent-by-me"] },
                  { "group": "Partners",          "pages": ["partner/introduction", "partner/create-instance", "partner/sign-instance", "partner/unsubscribe-instance", "partner/list-instances", "partner/update-instance"] },
                  { "group": "Integrators",       "pages": ["integrators/introduction"] }
                ]
              }
            ]
          }
        ]
      },
      {
        "language": "en",
        "navbar": {
          "links": [
            {
              "label": "Support",
              "href": "https://api.whatsapp.com/send?phone=554431421722&text=Hello,%20I%20would%20like%20to%20talk%20to%20Z-API%20support"
            }
          ],
          "primary": {
            "type": "button",
            "label": "Dashboard",
            "href": "https://app.z-api.io/"
          }
        },
        "tabs": [
          {
            "tab": "Documentation",
            "groups": [
              {
                "group": "Quick Start",
                "pages": ["en/quickstart/introduction"]
              },
              {
                "group": "Security",
                "pages": ["en/security/introduction", "en/security/ip-block", "en/security/twofactor", "en/security/client-token"]
              },
              {
                "group": "Tips",
                "pages": [
                  "en/tips/blockednumber",
                  "en/tips/blockednumbernew",
                  "en/tips/lid",
                  "en/tips/enable-fix-number",
                  "en/tips/emulators",
                  "en/tips/Z-APIvsAPI-OFICIAL",
                  "en/tips/button-status",
                  "en/tips/file-expiration",
                  "en/tips/postman-collection"
                ]
              }
            ]
          },
          {
            "tab": "API Reference",
            "groups": [
              {
                "group": "Overview",
                "pages": ["en/api-reference/introduction"]
              },
              {
                "group": "API Reference",
                "pages": [
                  { "group": "Instance",          "pages": ["en/instance/introduction", "en/instance/update-auto-read-message", "en/instance/update-auto-read-status", "en/instance/profile-picture", "en/instance/profile-name", "en/instance/profile-description", "en/instance/update-call-reject-auto", "en/instance/update-call-reject-message", "en/instance/qrcode", "en/instance/qr-code", "en/instance/qr-code-image", "en/instance/phone-code", "en/instance/restart", "en/instance/disconnect", "en/instance/status", "en/instance/device", "en/instance/rename-instance", "en/instance/me"] },
                  { "group": "Mobile",            "pages": ["en/mobile/introduction", "en/mobile/registration-available", "en/mobile/request-code", "en/mobile/captcha-confirm", "en/mobile/confirm-code", "en/mobile/request-unbanning", "en/mobile/confirm-security-code", "en/mobile/forgot-security-code", "en/mobile/get-account-email", "en/mobile/set-account-email", "en/mobile/verify-account-email", "en/mobile/get-has-security-code", "en/mobile/set-security-code", "en/mobile/remove-account-email", "en/mobile/remove-security-code"] },
                  { "group": "Messages",          "pages": ["en/message/introduction", "en/message/send-text", "en/message/forward-message", "en/message/send-message-reaction", "en/message/send-remove-reaction", "en/message/send-message-image", "en/message/send-message-sticker", "en/message/send-message-gif", "en/message/send-message-audio", "en/message/send-message-video", "en/message/send-message-ptv", "en/message/send-message-document", "en/message/send-message-link", "en/message/send-message-location", "en/message/send-message-product", "en/message/send-message-catalog", "en/message/send-message-contact", "en/message/send-message-multiple-contacts", "en/message/send-button-actions", "en/message/send-button-list", "en/message/send-button-list-image", "en/message/send-button-list-video", "en/message/send-option-list", "en/message/send-button-otp", "en/message/send-button-pix", "en/message/send-carousel", "en/message/delete-message", "en/message/read-message", "en/message/reply-message", "en/message/send-poll", "en/message/send-poll-vote", "en/message/send-message-order", "en/message/send-order-status-update", "en/message/send-order-payment-update", "en/message/send-pin-message", "en/message/send-newsletter-admin-invite", "en/message/send-event", "en/message/send-edit-event", "en/message/send-event-response"] },
                  { "group": "Privacy",           "pages": ["en/privacy/introduction", "en/privacy/get-disallowed-contacts", "en/privacy/set-last-seen", "en/privacy/set-photo-visualization", "en/privacy/set-privacy-description", "en/privacy/set-group-add-permission", "en/privacy/set-privacy-online", "en/privacy/set-read-receipts", "en/privacy/set-messages-duration"] },
                  { "group": "Contacts",          "pages": ["en/contacts/introduction", "en/contacts/get-contacts", "en/contacts/add-contacts", "en/contacts/remove-contacts", "en/contacts/get-metadata-contact", "en/contacts/get-profile-picture", "en/contacts/get-iswhatsapp", "en/contacts/get-iswhatsapp-batch", "en/contacts/block-contact", "en/contacts/report-contact"] },
                  { "group": "Chats",             "pages": ["en/chats/introduction", "en/chats/get-chats", "en/chats/get-metadata-chat", "en/chats/read-chat", "en/chats/archive-chat", "en/chats/pin-chat", "en/chats/mute-chat", "en/chats/clear-chat", "en/chats/delete-chat", "en/chats/send-chat-expiration"] },
                  { "group": "Calls",             "pages": ["en/calls/introduction", "en/calls/send-call", "en/calls/call-token", "en/calls/sip-token", "en/calls/sip-info"] },
                  { "group": "Groups",            "pages": ["en/group/introduction", "en/group/get-groups", "en/group/create-group", "en/group/update-group-name", "en/group/update-group-photo", "en/group/add-participant", "en/group/remove-participant", "en/group/approve-participant", "en/group/reject-participant", "en/group/mention-participant", "en/group/mention-group", "en/group/add-admin", "en/group/remove-admin", "en/group/leave-group", "en/group/metadata-group", "en/group/light-group-metadata", "en/group/group-invitation-metadata", "en/group/update-group-settings", "en/group/update-group-description", "en/group/redefine-invitation-link", "en/group/get-invitation-link", "en/group/accept-group-invite"] },
                  { "group": "Communities",       "pages": ["en/communities/introduction", "en/communities/create-community", "en/communities/list-communities", "en/communities/link-groups", "en/communities/unlink-groups", "en/communities/community-metadata", "en/communities/redefine-invitation-link", "en/communities/add-community-participant", "en/communities/remove-community-participant", "en/communities/add-community-admin", "en/communities/remove-community-admin", "en/communities/community-settings", "en/communities/deactivate-community", "en/communities/update-community-description"] },
                  { "group": "Meta AI",           "pages": ["en/metaai/introduction", "en/metaai/conversation"] },
                  { "group": "Newsletter",        "pages": ["en/newsletter/introduction", "en/newsletter/create-newsletter", "en/newsletter/update-newsletter-picture", "en/newsletter/update-newsletter-name", "en/newsletter/update-newsletter-description", "en/newsletter/follow-newsletter", "en/newsletter/unfollow-newsletter", "en/newsletter/mute-newsletter", "en/newsletter/unmute-newsletter", "en/newsletter/delete-newsletter", "en/newsletter/newsletter-metadata", "en/newsletter/newsletter-list", "en/newsletter/search-newsletter", "en/newsletter/update-newsletter-config", "en/newsletter/accept-newsletter-admin-invite", "en/newsletter/newsletter-remove-admin", "en/newsletter/newsletter-revoke-admin-invite", "en/newsletter/transfer-newsletter-ownership"] },
                  { "group": "Transmission List", "pages": ["en/broadcast/introduction"] },
                  { "group": "Status",            "pages": ["en/status/introduction", "en/status/send-text-status", "en/status/send-image-status", "en/status/send-video-status", "en/status/reply-status-text", "en/status/reply-status-gif", "en/status/reply-status-sticker"] },
                  { "group": "Message Queue",     "pages": ["en/queue/introduction", "en/queue/get-queue", "en/queue/post-queue", "en/queue/delete-queue", "en/queue/delete-queue-id"] },
                  { "group": "WhatsApp Business", "pages": ["en/business/introduction", "en/business/edit-product", "en/business/get-products", "en/business/get-products-phone", "en/business/get-products-v2", "en/business/get-products-phone-v2", "en/business/get-product-id", "en/business/delete-product", "en/business/tags", "en/business/tags-colors", "en/business/create-tag", "en/business/edit-tag", "en/business/delete-tag", "en/business/tags-add", "en/business/tags-remove", "en/business/chats-notes", "en/business/save-catalog-config", "en/business/create-collection", "en/business/list-collections", "en/business/delete-collection", "en/business/edit-collection", "en/business/list-collection-products", "en/business/add-product-to-collection", "en/business/remove-product-from-collection", "en/business/company-description", "en/business/company-email", "en/business/company-address", "en/business/company-websites", "en/business/business-hours", "en/business/available-categories", "en/business/company-categories", "en/business/profile"] },
                  { "group": "Webhooks",          "pages": ["en/webhooks/introduction", "en/webhooks/on-message-send", "en/webhooks/on-message-received", "en/webhooks/on-message-received-examples", "en/webhooks/on-whatsapp-disconnected", "en/webhooks/on-whatsapp-message-status-changes", "en/webhooks/on-chat-presence", "en/webhooks/on-chat-presence-examples", "en/webhooks/on-webhook-connected", "en/webhooks/update-every-webhooks", "en/webhooks/update-notify-sent-by-me"] },
                  { "group": "Partners",          "pages": ["en/partner/introduction", "en/partner/create-instance", "en/partner/sign-instance", "en/partner/unsubscribe-instance", "en/partner/list-instances", "en/partner/update-instance"] },
                  { "group": "Integrators",       "pages": ["en/integrators/introduction"] }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}