{
  "openapi": "3.0.3",
  "info": {
    "title": "Doiteasy WASMS API",
    "version": "2026.10",
    "description": "Doiteasy WhatsApp operations, account-scoped archives, webhooks, customer billing and clinic booking. Optional advanced operations require a separately paired browser device. Use Doiteasy API keys and documented request schemas."
  },
  "servers": [
    {
      "url": "https://wasms.doiteasy.net"
    }
  ],
  "components": {
    "securitySchemes": {
      "DoiteasyApiKey": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "DoiteasyApiKey": []
    }
  ],
  "paths": {
    "/api/v2/sendMessage": {
      "post": {
        "summary": "text",
        "tags": [
          "sendMessage"
        ],
        "description": "Immediate text, media, contact, location and poll only; documented options only. Scheduling and events return 501.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "phonenumber": "966500000000",
                "type": "text",
                "text": "Hello from Doiteasy"
              }
            }
          }
        },
        "x-permission": "wa_send",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/sendGroup": {
      "post": {
        "summary": "text",
        "tags": [
          "sendGroup"
        ],
        "description": "Immediate text, media, contact, location and poll only; documented options only. Scheduling and events return 501.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "groupId": "120000000000000@g.us",
                "type": "text",
                "text": "Hello from Doiteasy"
              }
            }
          }
        },
        "x-permission": "wa_send",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/getGroupList": {
      "get": {
        "summary": "Get Group List",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_group_chat_get_group_list",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/getChannels": {
      "get": {
        "summary": "Get Channels",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_channel_get_channels",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/sendMessage": {
      "post": {
        "summary": "Send to Channel",
        "tags": [
          "channel"
        ],
        "description": "Immediate text, media, contact, location and poll only; documented options only. Scheduling and events return 501.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter",
                "type": "text",
                "text": "Hello from Doiteasy"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_send_message",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/receivedMessages": {
      "get": {
        "summary": "Get Received Messages",
        "tags": [
          "message"
        ],
        "description": "Reads this account’s captured archive, with pagination. Does not promise full phone history.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer"
            },
            "example": 50
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_message_received_messages",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/sentMessages": {
      "get": {
        "summary": "Get Sent Messages",
        "tags": [
          "message"
        ],
        "description": "Reads this account’s captured archive, with pagination. Does not promise full phone history.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer"
            },
            "example": 50
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_message_sent_messages",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/webhook/set": {
      "post": {
        "summary": "Set Webhook",
        "tags": [
          "settings"
        ],
        "description": "Sets public HTTPS URL and events [message,receipt]. Returns signing secret once. At-least-once delivery, max 8 attempts; archive retained on delivery failure. See WEBHOOKS.md.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "url": "https://example.com/webhook",
                "events": [
                  "message",
                  "receipt"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_settings_webhook_set",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/webhook/event-scope": {
      "put": {
        "summary": "Set Event Scope",
        "tags": [
          "settings"
        ],
        "description": "Reads or replaces webhook event scope. PUT requires write permission and events array; GET is read-only. Reconfiguration clears queued deliveries.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "events": [
                  "message",
                  "receipt"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_settings_webhook_event_scope_write",
        "x-supported": true,
        "x-backend": "native"
      },
      "get": {
        "summary": "Get Event Scope",
        "tags": [
          "settings"
        ],
        "description": "Reads or replaces webhook event scope. PUT requires write permission and events array; GET is read-only. Reconfiguration clears queued deliveries.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_settings_webhook_event_scope_read",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/getSettings": {
      "get": {
        "summary": "Get All Settings",
        "tags": [
          "settings"
        ],
        "description": "Reads per-account WASMS v2 settings, redacted webhook configuration and delivery counts. Legacy Doiteasy settings remain separate.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_settings_get_settings",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/status": {
      "get": {
        "summary": "Get Sent Message Status",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "chatId",
            "schema": {
              "type": "string"
            },
            "example": "966500000000@c.us"
          },
          {
            "in": "query",
            "name": "messageId",
            "schema": {
              "type": "string"
            },
            "example": "MESSAGE_ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_message_status",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/pendings": {
      "get": {
        "summary": "Get All Pending Messages",
        "tags": [
          "message"
        ],
        "description": "Snapshot of the local account send queue; excludes unfetched Doiteasy jobs and in-flight immediate sends.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_message_pendings",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/forward": {
      "post": {
        "summary": "Forward",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID",
                "targetChatId": "966500000001@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_forward",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/star": {
      "post": {
        "summary": "Star Message",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_star",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/unstar": {
      "post": {
        "summary": "Unstar Message",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_unstar",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/reply": {
      "post": {
        "summary": "Reply to a Message",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID",
                "text": "Updated message"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_reply",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/react": {
      "post": {
        "summary": "React to a Message",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID",
                "reaction": "👍"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_react",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getQuotedMessage": {
      "post": {
        "summary": "Get Quoted Message",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_quoted_message",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/downloadMedia": {
      "post": {
        "summary": "Download Media",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_download_media",
        "x-supported": true,
        "x-backend": "native"
      },
      "get": {
        "summary": "downloadMedia",
        "description": "Authenticated media download.",
        "tags": [
          "message"
        ],
        "x-permission": "wa_v2_message_download_media",
        "x-supported": true,
        "x-backend": "native",
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        }
      }
    },
    "/api/v2/message/urlDownloadMedia": {
      "post": {
        "summary": "URL Download Media",
        "tags": [
          "message"
        ],
        "description": "Returns a relative download URL requiring the existing Bearer API key and download permission. Not an anonymous or expiring share URL.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "messageId": "ARCHIVED_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_url_download_media",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getPayment": {
      "post": {
        "summary": "Get Payment",
        "tags": [
          "message"
        ],
        "description": "Reads payment details present in the archived message; returns 404 if absent. Does not query a payment provider.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "messageId": "CAPTURED_MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_payment",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getOrder": {
      "post": {
        "summary": "Get Order",
        "tags": [
          "message"
        ],
        "description": "Reads order details present in the archived message; returns 404 if absent. Does not fetch a live commerce order.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "messageId": "CAPTURED_MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_order",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getInfo": {
      "post": {
        "summary": "Get Message Info",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_info",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getClassInfo": {
      "post": {
        "summary": "Get Class Info",
        "tags": [
          "message"
        ],
        "description": "Returns a safe normalized WASMS record; never serializes client secrets or a whatsapp-web.js class.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_class_info",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/delete": {
      "post": {
        "summary": "Delete Message",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_delete",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/edit": {
      "post": {
        "summary": "Edit Message",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID",
                "text": "Updated message"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_edit",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/pin": {
      "post": {
        "summary": "Pin Message",
        "tags": [
          "message"
        ],
        "description": "Pins an archived message. duration seconds: 86400, 604800 or 2592000. Default 86400.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "messageId": "ARCHIVED_ID",
                "duration": 86400
              }
            }
          }
        },
        "x-permission": "wa_v2_message_pin",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/unpin": {
      "post": {
        "summary": "Unpin Message",
        "tags": [
          "message"
        ],
        "description": "Unpins an archived message.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "messageId": "ARCHIVED_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_unpin",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getMentions": {
      "post": {
        "summary": "Get Mentions",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_mentions",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getGroupMentions": {
      "post": {
        "summary": "Get Group Mentions",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_group_mentions",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getReactions": {
      "post": {
        "summary": "Get Reactions",
        "tags": [
          "message"
        ],
        "description": "Returns captured reactions, latest per actor; historical reactions not received by this server are unavailable.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "messageId": "ARCHIVED_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_reactions",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/getPollVotes": {
      "post": {
        "summary": "Get Poll Votes",
        "tags": [
          "message"
        ],
        "description": "Returns captured and successfully decrypted votes as selected-option SHA256 hashes; not a guaranteed complete poll tally.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "messageId": "ARCHIVED_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_get_poll_votes",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/vote": {
      "post": {
        "summary": "Vote on Poll",
        "tags": [
          "message"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID",
                "options": [
                  "Yes"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_message_vote",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/message/editScheduledEvent": {
      "post": {
        "summary": "Edit Scheduled Event",
        "tags": [
          "message"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "messageId": "BROWSER_SERIALIZED_ID",
                "name": "Meeting",
                "startTime": "2026-10-01T12:00:00Z"
              }
            }
          }
        },
        "x-permission": "wa_v2_message_edit_scheduled_event",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/client/createGroup": {
      "post": {
        "summary": "Create Group",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "name": "Example group",
                "participants": [
                  "966500000000@c.us"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_client_create_group",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/leave": {
      "post": {
        "summary": "Leave Group",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_leave",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/addParticipants": {
      "post": {
        "summary": "Add Participants",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "participants": [
                  "966500000000@c.us"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_add_participants",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/removeParticipants": {
      "post": {
        "summary": "Remove Participants",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "participants": [
                  "966500000000@c.us"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_remove_participants",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/promoteParticipants": {
      "post": {
        "summary": "Promote Participants",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "participants": [
                  "966500000000@c.us"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_promote_participants",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/demoteParticipants": {
      "post": {
        "summary": "Demote Participants",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "participants": [
                  "966500000000@c.us"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_demote_participants",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/setPicture": {
      "post": {
        "summary": "Set Picture",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "url": "https://YOUR_PUBLIC_HOST/group.jpg"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_set_picture",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/deletePicture": {
      "post": {
        "summary": "Delete Picture",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_delete_picture",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/setMessagesAdminsOnly": {
      "post": {
        "summary": "Set Messages Admins Only",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "adminsOnly": true
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_set_messages_admins_only",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/setSubject": {
      "post": {
        "summary": "Set Subject",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "subject": "Example group"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_set_subject",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/setInfoAdminsOnly": {
      "post": {
        "summary": "Set Info Admins Only",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "adminsOnly": true
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_set_info_admins_only",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/setDescription": {
      "post": {
        "summary": "Set Description",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "description": "Team discussions"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_set_description",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/getInviteLink": {
      "post": {
        "summary": "Get Invite Link",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_get_invite_link",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/revokeInvite": {
      "post": {
        "summary": "Revoke Invite",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_revoke_invite",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/getClassInfo": {
      "post": {
        "summary": "Get Class Info",
        "tags": [
          "groupChat"
        ],
        "description": "Returns a safe normalized WASMS record; never serializes client secrets or a whatsapp-web.js class.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_get_class_info",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/setAddMembersAdminsOnly": {
      "post": {
        "summary": "Set Add Members Admins Only",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "adminsOnly": true
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_set_add_members_admins_only",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/getGroupMembershipRequests": {
      "post": {
        "summary": "Get Group Membership Requests",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_get_group_membership_requests",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/approveGroupMembershipRequests": {
      "post": {
        "summary": "Approve Group Membership Requests",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "participants": [
                  "966500000000@c.us"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_approve_group_membership_requests",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/groupChat/rejectGroupMembershipRequests": {
      "post": {
        "summary": "Reject Group Membership Requests",
        "tags": [
          "groupChat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "participants": [
                  "966500000000@c.us"
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_group_chat_reject_group_membership_requests",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/fetchMessages": {
      "post": {
        "summary": "Fetch Messages",
        "tags": [
          "chat"
        ],
        "description": "Reads this account’s captured archive, with pagination. Does not promise full phone history.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "limit": 50
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_fetch_messages",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/sendStateTyping": {
      "post": {
        "summary": "Send State Typing",
        "tags": [
          "chat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_send_state_typing",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/sendStateRecording": {
      "post": {
        "summary": "Send State Recording",
        "tags": [
          "chat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_send_state_recording",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/clearState": {
      "post": {
        "summary": "Clear State",
        "tags": [
          "chat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_clear_state",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/delete": {
      "post": {
        "summary": "Delete Chat",
        "tags": [
          "chat"
        ],
        "description": "Deletes the chat on WhatsApp using its latest captured message as the boundary. The WASMS archive and cached media are retained.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net"
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_delete",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/clearMessages": {
      "post": {
        "summary": "Clear Messages",
        "tags": [
          "chat"
        ],
        "description": "Optional browser: clears the WhatsApp chat; retains the WASMS archive.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_clear_messages",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/chat/getContact": {
      "post": {
        "summary": "Get Contact",
        "tags": [
          "chat"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_get_contact",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/getClassInfo": {
      "post": {
        "summary": "Get Class Info",
        "tags": [
          "chat"
        ],
        "description": "Returns a safe normalized WASMS record; never serializes client secrets or a whatsapp-web.js class.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_chat_get_class_info",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getChats": {
      "get": {
        "summary": "Get Chats",
        "tags": [
          "client"
        ],
        "description": "Reads this account’s captured archive, with pagination. Does not promise full phone history.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer"
            },
            "example": 50
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_client_get_chats",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getContacts": {
      "get": {
        "summary": "Get Contacts",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_client_get_contacts",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getState": {
      "get": {
        "summary": "Get State",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_client_get_state",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/searchMessages": {
      "post": {
        "summary": "Search Messages",
        "tags": [
          "client"
        ],
        "description": "Reads this account’s captured archive, with pagination. Does not promise full phone history.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "limit": 50,
                "query": "invoice"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_search_messages",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/isRegisteredUser": {
      "post": {
        "summary": "Is Registered User",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "phonenumber": "966500000000"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_is_registered_user",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/markChatUnread": {
      "post": {
        "summary": "Mark Chat Unread",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_mark_chat_unread",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/sendSeen": {
      "post": {
        "summary": "Send Seen",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_send_seen",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/pinChat": {
      "post": {
        "summary": "Pin Chat",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_pin_chat",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/unpinChat": {
      "post": {
        "summary": "Unpin Chat",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_unpin_chat",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/muteChat": {
      "post": {
        "summary": "Mute Chat",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "duration": 86400
              }
            }
          }
        },
        "x-permission": "wa_v2_client_mute_chat",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/unmuteChat": {
      "post": {
        "summary": "Unmute Chat",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_unmute_chat",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/archiveChat": {
      "post": {
        "summary": "Archive Chat",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_archive_chat",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/unarchiveChat": {
      "post": {
        "summary": "Unarchive Chat",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_unarchive_chat",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getBlockedContacts": {
      "post": {
        "summary": "Get Blocked Contacts",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_client_get_blocked_contacts",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getCommonGroups": {
      "post": {
        "summary": "Get Common Groups",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_common_groups",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getInviteInfo": {
      "post": {
        "summary": "Get Invite Info",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "inviteCode": "INVITE_CODE"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_invite_info",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/acceptInvite": {
      "post": {
        "summary": "Accept Invite",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "inviteCode": "INVITE_CODE"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_accept_invite",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/setStatus": {
      "post": {
        "summary": "Set Status",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "status": "Available for customer support"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_set_status",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/setProfilePicture": {
      "post": {
        "summary": "Set Profile Picture",
        "tags": [
          "client"
        ],
        "description": "Uploads a JPEG to the paired account profile; WhatsApp acceptance must be verified live.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "url": "https://example.com/profile.jpg"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_set_profile_picture",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getProfilePicUrl": {
      "post": {
        "summary": "Get Profile Pic Url",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_profile_pic_url",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getChatById": {
      "post": {
        "summary": "Get Chat By ID",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_chat_by_id",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getContactById": {
      "post": {
        "summary": "Get Contact By Id",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_contact_by_id",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getNumberId": {
      "post": {
        "summary": "Get Number Id",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "phonenumber": "966500000000"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_number_id",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getLabelById": {
      "post": {
        "summary": "Get Label By ID",
        "tags": [
          "client"
        ],
        "description": "Reads the account label last received from WhatsApp app-state sync. Returns 404 before synchronization.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "labelId": "1"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_label_by_id",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getChatLabels": {
      "post": {
        "summary": "Get Chat Labels",
        "tags": [
          "client"
        ],
        "description": "Reads captured chat-label associations. Empty does not guarantee that the phone has no labels.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_chat_labels",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/addOrRemoveLabels": {
      "post": {
        "summary": "Add Or Remove Labels",
        "tags": [
          "client"
        ],
        "description": "Adds/removes one existing synchronized label using chatId, labelId and labeled boolean. Does not replace all labels.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "labelId": "1",
                "labeled": true
              }
            }
          }
        },
        "x-permission": "wa_v2_client_add_or_remove_labels",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/sendPrecenseAvailable": {
      "post": {
        "summary": "Send Precense Available",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_client_send_precense_available",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/sendPrecenseUnavailable": {
      "post": {
        "summary": "Send Precense unAvailable",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_client_send_precense_unavailable",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getClassInfo": {
      "get": {
        "summary": "Get Class Info",
        "tags": [
          "client"
        ],
        "description": "Returns a safe normalized WASMS record; never serializes client secrets or a whatsapp-web.js class.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_client_get_class_info",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getContactDeviceCount": {
      "post": {
        "summary": "Get Contact Device Count",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_contact_device_count",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getMessageById": {
      "post": {
        "summary": "Get Message By Id",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us",
                "messageId": "MESSAGE_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_message_by_id",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/getPinnedMessages": {
      "post": {
        "summary": "Get Pinned Messages",
        "tags": [
          "client"
        ],
        "description": "Returns captured non-expired pins for chatId. Requires pin events to have reached this server.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_pinned_messages",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/createCallLink": {
      "post": {
        "summary": "Create Call Link",
        "tags": [
          "client"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "startTime": "2026-10-01T12:00:00Z",
                "callType": "voice"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_create_call_link",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/client/getBroadcasts": {
      "get": {
        "summary": "Get Broadcasts",
        "tags": [
          "client"
        ],
        "description": "Optional browser: lists status broadcasts, not bulk-send distribution lists.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-permission": "wa_v2_client_get_broadcasts",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/client/getBroadcastById": {
      "post": {
        "summary": "Get Broadcast By Id",
        "tags": [
          "client"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "contactId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_get_broadcast_by_id",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/client/deleteProfilePicture": {
      "post": {
        "summary": "Delete Profile Picture",
        "tags": [
          "client"
        ],
        "description": "Removes the paired account profile picture; WhatsApp acceptance must be verified live.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_client_delete_profile_picture",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/acceptGroupV4Invite": {
      "post": {
        "summary": "Accept Group V4 Invite",
        "tags": [
          "client"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "120000000000000@g.us",
                "inviter": "966500000000@c.us",
                "inviteCode": "INVITE_CODE",
                "expiration": 2000000000
              }
            }
          }
        },
        "x-permission": "wa_v2_client_accept_group_v4_invite",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/client/sendResponseToScheduledEvent": {
      "post": {
        "summary": "Send Response To Scheduled Event",
        "tags": [
          "client"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "messageId": "BROWSER_SERIALIZED_ID",
                "response": 1
              }
            }
          }
        },
        "x-permission": "wa_v2_client_send_response_to_scheduled_event",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/client/revokeStatusMessage": {
      "post": {
        "summary": "Revoke Status Message",
        "tags": [
          "client"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "messageId": "BROWSER_SERIALIZED_ID"
              }
            }
          }
        },
        "x-permission": "wa_v2_client_revoke_status_message",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/contact/getAbout": {
      "post": {
        "summary": "Get About",
        "tags": [
          "contact"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_contact_get_about",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/contact/getProfilePicUrl": {
      "post": {
        "summary": "Get Profile Pic URL",
        "tags": [
          "contact"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_contact_get_profile_pic_url",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/contact/block": {
      "post": {
        "summary": "Block Contact",
        "tags": [
          "contact"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_contact_block",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/contact/unblock": {
      "post": {
        "summary": "Unblock Contact",
        "tags": [
          "contact"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_contact_unblock",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/contact/getFormattedNumber": {
      "post": {
        "summary": "Get Formatted Number",
        "tags": [
          "contact"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "phonenumber": "966500000000"
              }
            }
          }
        },
        "x-permission": "wa_v2_contact_get_formatted_number",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/contact/getChat": {
      "post": {
        "summary": "Get Chat Info",
        "tags": [
          "contact"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_contact_get_chat",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/contact/getClassInfo": {
      "post": {
        "summary": "Get Class Info",
        "tags": [
          "contact"
        ],
        "description": "Returns a safe normalized WASMS record; never serializes client secrets or a whatsapp-web.js class.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_contact_get_class_info",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/createChannel": {
      "post": {
        "summary": "Create Channel",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "name": "Doiteasy updates",
                "description": "News and updates"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_create_channel",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/getChannelById": {
      "post": {
        "summary": "Get Channel By Id",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_get_channel_by_id",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/getChannelByInviteCode": {
      "post": {
        "summary": "Get Channel By Invite Code",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "inviteCode": "INVITE_CODE"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_get_channel_by_invite_code",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/searchChannels": {
      "post": {
        "summary": "Search Channels",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "searchText": "business",
                "limit": 50,
                "view": 0
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_search_channels",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/subscribeToChannel": {
      "post": {
        "summary": "Subscribe To Channel",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_subscribe_to_channel",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/unsubscribeFromChannel": {
      "post": {
        "summary": "Unsubscribe From Channel",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_unsubscribe_from_channel",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/getChannelSubscribers": {
      "post": {
        "summary": "Get Channel Subscribers",
        "tags": [
          "channel"
        ],
        "description": "Optional browser: returns visible subscribers (contacts only), not all channel subscribers.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "limit": 100
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_get_channel_subscribers",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/fetchMessages": {
      "post": {
        "summary": "Fetch Channel Messages",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter",
                "limit": 50
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_fetch_messages",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/sendSeen": {
      "post": {
        "summary": "Send Seen",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter",
                "messageIds": [
                  100
                ]
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_send_seen",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/setSubject": {
      "post": {
        "summary": "Set Subject",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "subject": "Business news"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_set_subject",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/setDescription": {
      "post": {
        "summary": "Set Description",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "description": "Updates"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_set_description",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/setProfilePicture": {
      "post": {
        "summary": "Set Profile Picture",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "data": "JPEG_BASE64"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_set_profile_picture",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/setReactionSetting": {
      "post": {
        "summary": "Set Reaction Setting",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "reactionCode": 0
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_set_reaction_setting",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/setChannelMetadata": {
      "post": {
        "summary": "Set Channel Metadata",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "property": "subject",
                "value": "Business news"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_set_channel_metadata",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/muteChannel": {
      "post": {
        "summary": "Mute Channel",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_mute_channel",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/unmuteChannel": {
      "post": {
        "summary": "Unmute Channel",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_unmute_channel",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/muteUnmuteChannel": {
      "post": {
        "summary": "Mute / Unmute Channel",
        "tags": [
          "channel"
        ],
        "description": "Implemented adapter. WhatsApp connection and target permissions are required.",
        "x-wasms-source-adapter": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "120000000000000@newsletter",
                "mute": true
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_mute_unmute_channel",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/channel/sendChannelAdminInvite": {
      "post": {
        "summary": "Send Channel Admin Invite",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "chatId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_send_channel_admin_invite",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/acceptChannelAdminInvite": {
      "post": {
        "summary": "Accept Channel Admin Invite",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_accept_channel_admin_invite",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/revokeChannelAdminInvite": {
      "post": {
        "summary": "Revoke Channel Admin Invite",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "userId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_revoke_channel_admin_invite",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/demoteChannelAdmin": {
      "post": {
        "summary": "Demote Channel Admin",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "userId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_demote_channel_admin",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/transferChannelOwnership": {
      "post": {
        "summary": "Transfer Channel Ownership",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter",
                "newOwnerId": "966500000000@c.us"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_transfer_channel_ownership",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/channel/deleteChannel": {
      "post": {
        "summary": "Delete Channel",
        "tags": [
          "channel"
        ],
        "description": "Optional browser backend required; separately pair the same phone. Uses whatsapp-web.js IDs and behavior.  Live account acceptance required.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "channelId": "123456789@newsletter"
              }
            }
          }
        },
        "x-permission": "wa_v2_channel_delete_channel",
        "x-supported": true,
        "x-backend": "browser"
      }
    },
    "/api/v2/settings/setSeen": {
      "post": {
        "summary": "Set Message Seen",
        "tags": [
          "settings"
        ],
        "description": "Sets automatic seen receipts for newly captured live incoming messages using enabled boolean.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "enabled": true
              }
            }
          }
        },
        "x-permission": "wa_v2_settings_set_seen",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/setReceive": {
      "post": {
        "summary": "Set Message Receive",
        "tags": [
          "settings"
        ],
        "description": "Controls new WASMS v2 archive capture using enabled boolean. Does not change legacy Doiteasy callbacks or erase existing history.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "enabled": true
              }
            }
          }
        },
        "x-permission": "wa_v2_settings_set_receive",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/enableCountryCode": {
      "post": {
        "summary": "Enable Country Code",
        "tags": [
          "settings"
        ],
        "description": "Enables country prefix handling for native sendMessage plain phone numbers using enabled boolean.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "enabled": true
              }
            }
          }
        },
        "x-permission": "wa_v2_settings_enable_country_code",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/setCountryCode": {
      "post": {
        "summary": "Set Country Code",
        "tags": [
          "settings"
        ],
        "description": "Sets 1–3 digit countryCode used for plain phone numbers when prefix handling is enabled.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "countryCode": "966"
              }
            }
          }
        },
        "x-permission": "wa_v2_settings_set_country_code",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/setRatelimit": {
      "post": {
        "summary": "Set Message Rate Limit",
        "tags": [
          "settings"
        ],
        "description": "Sets messagesPerMinute from 1 to 600 for native v2 send operations. Legacy sends and browser operations are separate.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "messagesPerMinute": 60
              }
            }
          }
        },
        "x-permission": "wa_v2_settings_set_ratelimit",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/settings/webhook/remove": {
      "post": {
        "summary": "Remove Webhook",
        "tags": [
          "settings"
        ],
        "description": "Disables webhook and removes its queued deliveries; keeps archived messages.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_settings_webhook_remove",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/service/create": {
      "post": {
        "summary": "Create WhatsApp Service",
        "tags": [
          "service"
        ],
        "description": "Creates a Doiteasy checkout order. Activation follows verified payment; upgrades use the prorated difference. The API does not charge the customer or activate an unpaid subscription. A new request_id is required per order; retries return the existing order.",
        "x-wasms-source-adapter": true,
        "parameters": [],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          },
          "422": {
            "description": "Invalid billing details or amount"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "plan_id": 2,
                "duration": 1,
                "request_id": "0123456789abcdef0123456789abcdef",
                "billing": {
                  "name": "Example Customer",
                  "email": "customer@example.com",
                  "country": "SA",
                  "phone": "500000000",
                  "phone_code": "966",
                  "locale": "en"
                }
              }
            }
          }
        },
        "x-permission": "wa_v2_service_create",
        "x-supported": true,
        "x-backend": "billing"
      }
    },
    "/api/v2/service/connect": {
      "post": {
        "summary": "Connect WhatsApp Service",
        "tags": [
          "service"
        ],
        "description": "Reconnects an existing paired native account; does not create or pay for a subscription.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_service_connect",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/service/disconnect": {
      "post": {
        "summary": "Disconnect WhatsApp Service",
        "tags": [
          "service"
        ],
        "description": "Disconnects the native session, retaining pairing credentials. Does not cancel a subscription or stop the optional browser.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_service_disconnect",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/service/renew": {
      "post": {
        "summary": "Renew WhatsApp Service",
        "tags": [
          "service"
        ],
        "description": "Creates a Doiteasy checkout order. Activation follows verified payment; upgrades use the prorated difference. The API does not charge the customer or activate an unpaid subscription. A new request_id is required per order; retries return the existing order.",
        "x-wasms-source-adapter": true,
        "parameters": [],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          },
          "422": {
            "description": "Invalid billing details or amount"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "plan_id": 2,
                "duration": 1,
                "request_id": "0123456789abcdef0123456789abcdef",
                "billing": {
                  "name": "Example Customer",
                  "email": "customer@example.com",
                  "country": "SA",
                  "phone": "500000000",
                  "phone_code": "966",
                  "locale": "en"
                }
              }
            }
          }
        },
        "x-permission": "wa_v2_service_renew",
        "x-supported": true,
        "x-backend": "billing"
      }
    },
    "/api/v2/service/upgrade": {
      "post": {
        "summary": "Upgrade WhatsApp Service",
        "tags": [
          "service"
        ],
        "description": "Creates a Doiteasy checkout order. Activation follows verified payment; upgrades use the prorated difference. The API does not charge the customer or activate an unpaid subscription. A new request_id is required per order; retries return the existing order.",
        "x-wasms-source-adapter": true,
        "parameters": [],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          },
          "422": {
            "description": "Invalid billing details or amount"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "plan_id": 2,
                "duration": 1,
                "request_id": "0123456789abcdef0123456789abcdef",
                "billing": {
                  "name": "Example Customer",
                  "email": "customer@example.com",
                  "country": "SA",
                  "phone": "500000000",
                  "phone_code": "966",
                  "locale": "en"
                }
              }
            }
          }
        },
        "x-permission": "wa_v2_service_upgrade",
        "x-supported": true,
        "x-backend": "billing"
      }
    },
    "/api/v2/service/getAllServices": {
      "post": {
        "summary": "Get All WhatsApp Services",
        "tags": [
          "service"
        ],
        "description": "Lists up to 1000 WhatsApp accounts owned by the authenticated Doiteasy user. Public PHP endpoint only; no account parameter required.",
        "x-wasms-source-adapter": false,
        "parameters": [],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_service_get_all_services",
        "x-supported": true,
        "x-backend": "zender"
      }
    },
    "/api/v2/service/getAllPlans": {
      "post": {
        "summary": "Get All Plans",
        "tags": [
          "service"
        ],
        "description": "Lists up to 1000 visible paid Doiteasy packages. Public PHP endpoint only; no account parameter required. Prices are the amounts configured in the Doiteasy catalog.",
        "x-wasms-source-adapter": false,
        "parameters": [],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_service_get_all_plans",
        "x-supported": true,
        "x-backend": "zender"
      }
    },
    "/api/v2/service/getAllActivities": {
      "post": {
        "summary": "Get All Activities",
        "tags": [
          "service"
        ],
        "description": "Returns up to 200 captured WASMS archive events for the selected account, using after cursor. Not provider billing activities.",
        "x-wasms-source-adapter": false,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "x-permission": "wa_v2_service_get_all_activities",
        "x-supported": true,
        "x-backend": "native"
      }
    },
    "/api/v2/chat/requestHistory": {
      "post": {
        "summary": "Request older chat history",
        "description": "Requests 1–50 messages before a captured anchor from the paired phone. Default: oldest archived message, count 50. 120-second per-chat cooldown. Delivery is asynchronous and may return no history; never promises all old/deleted chats.",
        "tags": [
          "chat"
        ],
        "x-permission": "wa_v2_chat_request_history",
        "x-supported": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "chatId": "966500000000@s.whatsapp.net",
                "count": 50
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-backend": "native"
      }
    },
    "/api/v2/chat/historyStatus": {
      "get": {
        "summary": "Chat history sync status",
        "description": "Returns archive message count, oldest/newest timestamps, last request and last observed sync chunk. Batch progress is not proof of complete recovery.",
        "tags": [
          "chat"
        ],
        "x-permission": "wa_v2_chat_history_status",
        "x-supported": true,
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "chatId",
            "schema": {
              "type": "string"
            },
            "example": "966500000000@s.whatsapp.net"
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        },
        "x-backend": "native"
      }
    },
    "/api/v2/browser/start": {
      "post": {
        "summary": "start",
        "description": "Optional browser linked-device lifecycle. Status exposes the pairing QR privately. ",
        "tags": [
          "browser"
        ],
        "x-permission": "wa_v2_browser_start",
        "x-supported": true,
        "x-backend": "browser",
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        }
      }
    },
    "/api/v2/browser/status": {
      "get": {
        "summary": "status",
        "description": "Optional browser linked-device lifecycle. Status exposes the pairing QR privately. ",
        "tags": [
          "browser"
        ],
        "x-permission": "wa_v2_browser_status",
        "x-supported": true,
        "x-backend": "browser",
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        }
      }
    },
    "/api/v2/browser/stop": {
      "post": {
        "summary": "stop",
        "description": "Optional browser linked-device lifecycle. Status exposes the pairing QR privately. ",
        "tags": [
          "browser"
        ],
        "x-permission": "wa_v2_browser_stop",
        "x-supported": true,
        "x-backend": "browser",
        "parameters": [
          {
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "Operation result; see documented limitations."
          },
          "403": {
            "description": "API permission denied"
          },
          "409": {
            "description": "Account not ready"
          },
          "429": {
            "description": "Busy or rate limited"
          },
          "501": {
            "description": "Provider provisioning/billing not implemented"
          },
          "503": {
            "description": "Required backend unavailable"
          }
        }
      }
    },
    "/api/bookings/state": {
      "get": {
        "summary": "List businesses and paginated reservations",
        "tags": [
          "Bookings"
        ],
        "description": "Tenant-scoped businesses, departments, doctors and 20 reservations per page. Optional filters: property_id, doctor_id, status, from, to and page. No submitted uid is accepted. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [
          {
            "name": "property_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 1
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "properties": [],
                    "departments": [],
                    "doctors": [],
                    "appointments": {
                      "rows": [],
                      "total": 0,
                      "page": 1
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_read",
        "x-supported": true,
        "x-backend": "booking"
      }
    },
    "/api/bookings/availability": {
      "get": {
        "summary": "Find available doctor appointments",
        "tags": [
          "Bookings"
        ],
        "description": "Returns free start/end ISO 8601 times and local labels in the business timezone. Weekly hours, date exceptions, duration, buffer, lead time, existing appointments and active 10-minute holds are applied. No patient data is returned. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [
          {
            "name": "property_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "example": 1
            }
          },
          {
            "name": "doctor_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "example": 1
            }
          },
          {
            "name": "date",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "example": "2026-11-01"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": [
                    {
                      "start": "2026-11-01T09:00:00+03:00",
                      "end": "2026-11-01T09:30:00+03:00",
                      "label": "09:00"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_read",
        "x-supported": true,
        "x-backend": "booking"
      }
    },
    "/api/bookings/calendar": {
      "get": {
        "summary": "Read the appointment calendar",
        "tags": [
          "Bookings"
        ],
        "description": "Returns confirmed appointments in an inclusive local date range of at most 42 days. A maximum of 2000 appointments is returned; use the paginated reservation list for larger views. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [
          {
            "name": "property_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "example": 1
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "example": "2026-11-01"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "example": "2026-11-30"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": []
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_read",
        "x-supported": true,
        "x-backend": "booking"
      }
    },
    "/api/bookings/property": {
      "post": {
        "summary": "Create or update a business",
        "tags": [
          "Bookings"
        ],
        "description": "Omit id to create; include id to update. Business ownership is enforced. Use an IANA timezone. reminders contains up to four offsets in minutes, each 5–10080. Empty reminders disables them. Guided chat requires an owned WhatsApp device, one business per device. New public pages and chats are disabled unless explicitly enabled. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "id": 1,
                    "name": "Care Clinic",
                    "slug": "care-clinic",
                    "timezone": "Asia/Riyadh",
                    "public_enabled": 0,
                    "chat_enabled": 0
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_write",
        "x-supported": true,
        "x-backend": "booking",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "Care Clinic"
                  },
                  "slug": {
                    "type": "string",
                    "example": "care-clinic"
                  },
                  "timezone": {
                    "type": "string",
                    "example": "Asia/Riyadh"
                  },
                  "locale": {
                    "type": "string",
                    "example": "en"
                  },
                  "address": {
                    "type": "string",
                    "example": "Riyadh"
                  },
                  "wa_account": {
                    "type": "string",
                    "example": "ACCOUNT_UNIQUE"
                  },
                  "public_enabled": {
                    "type": "boolean",
                    "example": false
                  },
                  "chat_enabled": {
                    "type": "boolean",
                    "example": false
                  },
                  "reminders": {
                    "type": "array",
                    "example": [
                      1440,
                      60
                    ]
                  },
                  "active": {
                    "type": "boolean",
                    "example": true
                  },
                  "category": {
                    "type": "string",
                    "enum": [
                      "healthcare",
                      "hospital",
                      "dental",
                      "car_maintenance",
                      "car_dealership",
                      "salon",
                      "consulting",
                      "custom"
                    ]
                  },
                  "labels": {
                    "type": "object",
                    "maxProperties": 10,
                    "additionalProperties": {
                      "type": "string",
                      "maxLength": 60
                    }
                  }
                }
              },
              "example": {
                "name": "Care Clinic",
                "slug": "care-clinic",
                "timezone": "Asia/Riyadh",
                "locale": "en",
                "address": "Riyadh",
                "wa_account": "ACCOUNT_UNIQUE",
                "public_enabled": false,
                "chat_enabled": false,
                "reminders": [
                  1440,
                  60
                ],
                "active": true
              }
            }
          }
        }
      }
    },
    "/api/bookings/department": {
      "post": {
        "summary": "Create or update a department",
        "tags": [
          "Bookings"
        ],
        "description": "Omit id to create; include id to update. active=false archives the department. A doctor must belong to a department in the same business. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "id": 1
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_write",
        "x-supported": true,
        "x-backend": "booking",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "property_id": {
                    "type": "integer",
                    "example": 1
                  },
                  "name": {
                    "type": "string",
                    "example": "General medicine"
                  },
                  "active": {
                    "type": "boolean",
                    "example": true
                  }
                }
              },
              "example": {
                "property_id": 1,
                "name": "General medicine",
                "active": true
              }
            }
          }
        }
      }
    },
    "/api/bookings/doctor": {
      "post": {
        "summary": "Create or update a doctor and weekly hours",
        "tags": [
          "Bookings"
        ],
        "description": "Omit id to create; include id to update. schedule contains seven arrays, Sunday=0 through Saturday=6, of ordered non-overlapping [HH:mm,HH:mm] intervals. Empty days are closed. Duration: 5–240 minutes; buffer: 0–120; lead_minutes: 0–10080; horizon_days: 1–180. Existing reservations remain reserved when hours change. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "id": 1
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_write",
        "x-supported": true,
        "x-backend": "booking",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "property_id": {
                    "type": "integer",
                    "example": 1
                  },
                  "department_id": {
                    "type": "integer",
                    "example": 1
                  },
                  "name": {
                    "type": "string",
                    "example": "Dr. Sarah"
                  },
                  "duration": {
                    "type": "integer",
                    "example": 30
                  },
                  "buffer": {
                    "type": "integer",
                    "example": 5
                  },
                  "lead_minutes": {
                    "type": "integer",
                    "example": 120
                  },
                  "horizon_days": {
                    "type": "integer",
                    "example": 60
                  },
                  "active": {
                    "type": "boolean",
                    "example": true
                  },
                  "schedule": {
                    "type": "array",
                    "example": [
                      [
                        [
                          "09:00",
                          "17:00"
                        ]
                      ],
                      [
                        [
                          "09:00",
                          "17:00"
                        ]
                      ],
                      [
                        [
                          "09:00",
                          "17:00"
                        ]
                      ],
                      [
                        [
                          "09:00",
                          "17:00"
                        ]
                      ],
                      [
                        [
                          "09:00",
                          "17:00"
                        ]
                      ],
                      [],
                      []
                    ]
                  }
                }
              },
              "example": {
                "property_id": 1,
                "department_id": 1,
                "name": "Dr. Sarah",
                "duration": 30,
                "buffer": 5,
                "lead_minutes": 120,
                "horizon_days": 60,
                "active": true,
                "schedule": [
                  [
                    [
                      "09:00",
                      "17:00"
                    ]
                  ],
                  [
                    [
                      "09:00",
                      "17:00"
                    ]
                  ],
                  [
                    [
                      "09:00",
                      "17:00"
                    ]
                  ],
                  [
                    [
                      "09:00",
                      "17:00"
                    ]
                  ],
                  [
                    [
                      "09:00",
                      "17:00"
                    ]
                  ],
                  [],
                  []
                ]
              }
            }
          }
        }
      }
    },
    "/api/bookings/exception": {
      "post": {
        "summary": "Set availability or a day off for one date",
        "tags": [
          "Bookings"
        ],
        "description": "An empty intervals array closes the doctor’s date. Set reset=true to remove the exception and restore weekly hours. Existing appointments remain reserved. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "ok": true
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_write",
        "x-supported": true,
        "x-backend": "booking",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "property_id": {
                    "type": "integer",
                    "example": 1
                  },
                  "doctor_id": {
                    "type": "integer",
                    "example": 1
                  },
                  "date": {
                    "type": "string",
                    "example": "2026-11-01"
                  },
                  "intervals": {
                    "type": "array",
                    "example": []
                  }
                }
              },
              "example": {
                "property_id": 1,
                "doctor_id": 1,
                "date": "2026-11-01",
                "intervals": []
              }
            }
          }
        }
      }
    },
    "/api/bookings/reserve": {
      "post": {
        "summary": "Reserve an appointment",
        "tags": [
          "Bookings"
        ],
        "description": "Creates a confirmed staff reservation. start must match an available ISO 8601 slot. request_id is a unique 32-character lowercase hex idempotency key. Concurrent reservation attempts are serialized for each doctor; an occupied slot returns 409. consent=true is required before sending WhatsApp confirmations and reminders. A private manage_token is returned once; protect it like a password. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "id": "APPOINTMENT_ID",
                    "status": "confirmed",
                    "manage_token": "PRIVATE_MANAGE_TOKEN"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_write",
        "x-supported": true,
        "x-backend": "booking",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "property_id": {
                    "type": "integer",
                    "example": 1
                  },
                  "doctor_id": {
                    "type": "integer",
                    "example": 1
                  },
                  "start": {
                    "type": "string",
                    "example": "2026-11-01T09:00:00+03:00"
                  },
                  "customer_name": {
                    "type": "string",
                    "example": "Example patient"
                  },
                  "phone": {
                    "type": "string",
                    "example": "+966500000000"
                  },
                  "consent": {
                    "type": "boolean",
                    "example": true
                  },
                  "request_id": {
                    "type": "string",
                    "example": "0123456789abcdef0123456789abcdef"
                  }
                }
              },
              "example": {
                "property_id": 1,
                "doctor_id": 1,
                "start": "2026-11-01T09:00:00+03:00",
                "customer_name": "Example patient",
                "phone": "+966500000000",
                "consent": true,
                "request_id": "0123456789abcdef0123456789abcdef"
              }
            }
          }
        }
      }
    },
    "/api/bookings/status": {
      "post": {
        "summary": "Cancel or complete an appointment",
        "tags": [
          "Bookings"
        ],
        "description": "Allowed values: cancelled, completed, no_show. Future appointments cannot be marked completed/no_show. Cancellation releases the slot and cancels pending reminders. Terminal states cannot be rewritten. Requires an enabled one-time Appointing add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Tenant-scoped result in the data property",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "id": "APPOINTMENT_ID",
                    "status": "cancelled"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid booking details"
          },
          "401": {
            "description": "Bearer API key required"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "404": {
            "description": "Owned resource not found"
          },
          "409": {
            "description": "Slot unavailable or invalid state change"
          },
          "423": {
            "description": "Account billing hold"
          },
          "429": {
            "description": "Too many reservation attempts"
          }
        },
        "x-permission": "booking_write",
        "x-supported": true,
        "x-backend": "booking",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "example": "0123456789abcdef0123456789abcdef"
                  },
                  "status": {
                    "type": "string",
                    "example": "cancelled"
                  }
                }
              },
              "example": {
                "id": "0123456789abcdef0123456789abcdef",
                "status": "cancelled"
              }
            }
          }
        }
      }
    },
    "/api/logistics/state": {
      "get": {
        "operationId": "logistics_state",
        "summary": "Logistics workspace",
        "description": "All workspaces, redacted carrier connections, paginated shipments (20 per page), delivery counts and support handoffs. Never returns API credentials. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "parameters": [
          {
            "name": "profile_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "carrier",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/api/logistics/profile": {
      "post": {
        "operationId": "logistics_profile",
        "summary": "Save logistics workspace",
        "description": "Create or update an owned workspace. active starts false. workflow is an ordered list of keyword rules and actions. One active workspace per WhatsApp device. BOOK remains routed to Appointing first. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "name": "Delivery team",
                "locale": "en",
                "wa_account": "YOUR_DEVICE_ID",
                "active": false,
                "welcome": "Welcome! Send TRACK or SUPPORT.",
                "poll_minutes": 120,
                "workflow": [
                  {
                    "id": "support",
                    "title": "Support",
                    "keywords": [
                      "support",
                      "دعم",
                      "2"
                    ],
                    "match": "exact",
                    "active": true,
                    "actions": [
                      {
                        "type": "support",
                        "name": "Support team",
                        "phone": "+966500000000",
                        "pause_minutes": 60
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    },
    "/api/logistics/integration": {
      "post": {
        "operationId": "logistics_integration",
        "summary": "Save carrier connection",
        "description": "Supported carriers: dhl, fedex, aramex, naqel and spl. Client-owned credentials are encrypted and never returned. Empty credential values retain saved values. A credential or environment change requires another test. SPL requires the official partner JSON endpoint and response mapping assigned to the account. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "carrier": "dhl",
                "label": "My DHL account",
                "environment": "sandbox",
                "active": true,
                "daily_limit": 200,
                "credentials": {
                  "api_key": "YOUR_DHL_API_KEY"
                }
              }
            }
          }
        }
      }
    },
    "/api/logistics/test": {
      "post": {
        "operationId": "logistics_test",
        "summary": "Test carrier connection",
        "description": "Looks up a valid tracking number using the saved connection and marks a successful connection tested. Does not send WhatsApp or create a shipment. Carrier limits apply. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "id": 1,
                "tracking_no": "YOUR_TRACKING_NUMBER"
              }
            }
          }
        }
      }
    },
    "/api/logistics/shipment": {
      "post": {
        "operationId": "logistics_shipment",
        "summary": "Save tracked shipment",
        "description": "Create or update an owned shipment. Explicit consent is required for proactive WhatsApp updates. Tracking number and carrier account are immutable after creation; archive and create a new record instead. Sandbox status never notifies customers. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "profile_id": 1,
                "integration_id": 1,
                "tracking_no": "YOUR_TRACKING_NUMBER",
                "reference": "ORDER-1001",
                "customer_name": "Customer",
                "phone": "+966500000000",
                "consent": true,
                "active": true
              }
            }
          }
        }
      }
    },
    "/api/logistics/poll": {
      "post": {
        "operationId": "logistics_poll",
        "summary": "Refresh shipment status",
        "description": "Checks the configured carrier, records normalized event history and queues one notification for each changed production event. Per-account daily limits, six-second connection cooldown and one-minute shipment cooldown apply. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "id": "OWNED_SHIPMENT_ID"
              }
            }
          }
        }
      }
    },
    "/api/logistics/preview": {
      "post": {
        "operationId": "logistics_preview",
        "summary": "Preview reply workflow",
        "description": "Dry run against a message. Returns matching rule and welcome text without queueing or sending messages. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "profile_id": 1,
                "text": "SUPPORT"
              }
            }
          }
        }
      }
    },
    "/api/logistics/handoff": {
      "post": {
        "operationId": "logistics_handoff",
        "summary": "Pause or resume automation",
        "description": "Pause a customer conversation for 5–1440 minutes. minutes=0 resumes automation after a support handoff, but never overrides a customer STOP opt out. Requires an enabled one-time Logistics add-on on the API key owner account. Purchase it in /store; missing access returns HTTP 403 addon_required. Existing API scope and tenant checks still apply.",
        "tags": [
          "Logistics Module"
        ],
        "security": [
          {
            "DoiteasyApiKey": []
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "403": {
            "description": "Access denied: addon_required when the matching digital add-on is not enabled, or the API scope/tenant permission is missing."
          },
          "422": {
            "description": "Configuration or carrier error"
          },
          "429": {
            "description": "Provider or daily rate limit"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "profile_id": 1,
                "phone": "+966500000000",
                "minutes": 60
              }
            }
          }
        }
      }
    },
    "/api/v2/cloud/authentication": {
      "post": {
        "summary": "Send Copy code OTP",
        "tags": [
          "cloud"
        ],
        "description": "Cloud API Authentication template with a native Copy code button. Configure the tenant-owned Meta connection at /dashboard/cloud first. Requires wa_send, an active WhatsApp plan and quota. Your application generates, expires and validates the 6-digit code. Idempotency is scoped to the API-key owner; reuse the same request_id for the same request. An uncertain/rejected request is never resent automatically. Success means accepted by Meta, not delivered. No linked-device account query is needed.",
        "x-permission": "wa_send",
        "x-supported": true,
        "x-backend": "native",
        "responses": {
          "200": {
            "description": "Saved status or Meta acceptance; not proof of delivery."
          },
          "401": {
            "description": "Invalid WASMS API key"
          },
          "403": {
            "description": "Permission, subscription or suspended user"
          },
          "409": {
            "description": "Setup, template, expiry or idempotency mismatch"
          },
          "423": {
            "description": "Billing hold"
          },
          "429": {
            "description": "Quota or rate limit"
          },
          "502": {
            "description": "Unknown Meta result; do not resend automatically"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "phonenumber",
                  "code",
                  "language",
                  "expires_in_minutes",
                  "request_id"
                ],
                "properties": {
                  "phonenumber": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{7,14}$"
                  },
                  "code": {
                    "type": "string",
                    "pattern": "^[0-9]{6}$"
                  },
                  "language": {
                    "type": "string",
                    "enum": [
                      "en",
                      "ar"
                    ]
                  },
                  "expires_in_minutes": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 15
                  },
                  "request_id": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{32,64}$"
                  }
                }
              },
              "example": {
                "phonenumber": "966500000000",
                "code": "123456",
                "language": "ar",
                "expires_in_minutes": 5,
                "request_id": "0123456789abcdef0123456789abcdef"
              }
            }
          }
        }
      }
    },
    "/api/v2/cloud/status": {
      "get": {
        "summary": "Cloud connection status",
        "tags": [
          "cloud"
        ],
        "description": "Read saved enabled/token-present/template/check status for the authenticated tenant only. Meta credentials are never returned. This is not a fresh Meta connectivity check.",
        "x-permission": "wa_send",
        "x-supported": true,
        "x-backend": "native",
        "responses": {
          "200": {
            "description": "Saved status or Meta acceptance; not proof of delivery."
          },
          "401": {
            "description": "Invalid WASMS API key"
          },
          "403": {
            "description": "Permission, subscription or suspended user"
          },
          "409": {
            "description": "Setup, template, expiry or idempotency mismatch"
          },
          "423": {
            "description": "Billing hold"
          },
          "429": {
            "description": "Quota or rate limit"
          },
          "502": {
            "description": "Unknown Meta result; do not resend automatically"
          }
        }
      }
    }
  }
}
