iZap.ai

iZap.ai Menus API

Product catalog menus a business publishes to its customers.

GitHub OpenAPI

Operations 3

GET /api/v1/businesses/menus List the business menus #
POST /api/v1/businesses/menus Create a menu #
PUT /api/v1/businesses/menus/{menu_id} Update a menu #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/izap-ai/openapi/izap-ai-menus-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/izap-ai/json-schema/izap-ai-create-transmission-preview-in-schema.json
📊
JSONSchema
https://artifacts.apis.io/izap-ai/json-schema/izap-ai-whats-app-template-out-schema.json
📊
JSONSchema
https://artifacts.apis.io/izap-ai/json-schema/izap-ai-transmission-preview-out-schema.json
📊
JSONSchema
https://artifacts.apis.io/izap-ai/json-schema/izap-ai-transmission-status-out-schema.json
📊
JSONSchema
https://artifacts.apis.io/izap-ai/json-schema/izap-ai-whats-app-template-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/izap-ai/json-schema/izap-ai-whats-app-template-update-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/izap-ai:izap-ai-menus-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

izap-ai-menus-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@izap.ai
    name: iZap API Support
  description: Public REST API for the iZap WhatsApp business messaging platform.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  title: iZap Menus API
  version: v1
servers:
- description: Production
  url: https://api.izap.ai
- description: Staging
  url: https://api-staging.izap.ai
tags:
- description: Product catalog menus a business publishes to its customers.
  name: Menus
paths:
  /api/v1/businesses/menus:
    get:
      description: Returns the product catalog menus published by the business named in the `business-id` header.
      operationId: listBusinessMenus
      parameters:
      - in: header
        name: business-id
        required: true
        schema:
          format: uuid
          title: Business-Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessMenuOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: List the business menus
      tags:
      - Menus
    post:
      description: Creates a product catalog menu for the business named in the `business-id` header.
      operationId: createBusinessMenu
      parameters:
      - in: header
        name: business-id
        required: true
        schema:
          format: uuid
          title: Business-Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenuUpdateIn'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MenusOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: Create a menu
      tags:
      - Menus
  /api/v1/businesses/menus/{menu_id}:
    put:
      description: Replaces the contents of an existing menu.
      operationId: updateBusinessMenu
      parameters:
      - in: path
        name: menu_id
        required: true
        schema:
          title: Menu Id
          type: string
      - in: header
        name: business-id
        required: true
        schema:
          format: uuid
          title: Business-Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenuUpdateIn'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MenusOut'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The credential is valid but not authorized for this action.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource, or the business named in the request, does not exist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unexpected error.
      security:
      - bearerAuth: []
      summary: Update a menu
      tags:
      - Menus
components:
  schemas:
    ApiError:
      description: 'The response body of a handled API error.


        ``detail`` is either a plain string (FastAPI''s default for an

        ``HTTPException`` raised with a string, and for the ``default`` fastapi-users

        messages like ``"Not authenticated"``) or the structured

        :class:`ApiErrorDetail` object described above. ``code`` is present only on

        the top-level shape ``aizap.core.exceptions.AppException`` produces for its

        own 5xx responses (``"INTERNAL_ERROR"`` / ``"DB_ERROR"``); it does not

        duplicate the ``code`` nested inside a structured ``detail``.'
      properties:
        code:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          title: Code
        detail:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ApiErrorDetail'
          title: Detail
      required:
      - detail
      title: ApiError
      type: object
    BusinessMenuOut:
      properties:
        business_name:
          title: Business Name
          type: string
        id:
          format: uuid
          title: Id
          type: string
        menus:
          items:
            $ref: '#/components/schemas/MenusOut'
          title: Menus
          type: array
      required:
      - id
      - business_name
      - menus
      title: BusinessMenuOut
      type: object
    MenusOut:
      properties:
        id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          title: Id
        menu_json:
          title: Menu Json
      required:
      - menu_json
      title: MenusOut
      type: object
    ApiErrorDetail:
      additionalProperties: true
      description: 'The structured ``detail`` object some error responses carry.


        Several handlers (the REST API plan gate, the free-tier limits, the

        webhooks entitlement gate, the closed customer-service window) raise

        ``HTTPException(detail={"code": ..., "message": ..., ...})`` — a fixed

        ``code``/``message`` pair plus extra fields specific to that error.

        ``extra="allow"`` keeps those fields in the documented shape instead of

        dropping them.'
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
      required:
      - code
      - message
      title: ApiErrorDetail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    MenuUpdateIn:
      properties:
        menu_json:
          title: Menu Json
      required:
      - menu_json
      title: MenuUpdateIn
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
  securitySchemes:
    bearerAuth:
      description: 'Personal access token (izap_pat_…) sent as Authorization: Bearer <token>; dashboard session JWTs are also accepted.'
      scheme: bearer
      type: http