{"openapi":"3.1.0","info":{"title":"WhatsApp Account Admin (BYOK) API","version":"0.1.0","description":"WhatsApp Account Admin (BYOK) lets an AI assistant read your own WhatsApp Account Admin data through the WhatsApp Account Admin API with a key you supply (system user access token with whatsapp_business_management permission). Read-only: 6 tools (list_account_activities, list_subscribed_apps, list_qr_codes, get_qr_code, get_official_business_account_status, get_phone_number_settings). The BYOK...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-whatsapp-account-admin.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-whatsapp-account-admin/docs"},"termsOfService":"https://connectorbay.com/byok-whatsapp-account-admin/terms"},"servers":[{"url":"https://byok-whatsapp-account-admin.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-whatsapp-account-admin/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_account_activities":{"post":{"operationId":"list_account_activities","summary":"List the WhatsApp Business Account activity log: what changed (phone number added, template edited, calling status chang","description":"List the WhatsApp Business Account activity log: what changed (phone number added, template edited, calling status changed, user added and similar), the category, the actor ID and the time. Use for \"What changed recently on my WhatsApp Business account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"waba_id":{"description":"WhatsApp Business Account ID (digits), shown in WhatsApp Manager.","maxLength":30,"title":"Waba Id","type":"string"},"fields":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":"id,actor_business_id,actor_id,category,event_type,timestamp","description":"Comma-separated fields to return: id, actor_business_id, actor_id, category, event_type, timestamp.","title":"Fields"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many records per page (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: paging.cursors.after from the previous answer.","title":"After"}},"required":["waba_id"],"title":"list_account_activitiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_subscribed_apps":{"post":{"operationId":"list_subscribed_apps","summary":"List the apps subscribed to a WhatsApp Business Account's webhooks, with each app's ID, name and any custom callback URL","description":"List the apps subscribed to a WhatsApp Business Account's webhooks, with each app's ID, name and any custom callback URL. Use for \"Which apps receive webhooks for my WhatsApp Business account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"waba_id":{"description":"WhatsApp Business Account ID (digits), shown in WhatsApp Manager.","maxLength":30,"title":"Waba Id","type":"string"},"fields":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":"id,name,link","description":"Comma-separated fields: id, name, link.","title":"Fields"}},"required":["waba_id"],"title":"list_subscribed_appsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_qr_codes":{"post":{"operationId":"list_qr_codes","summary":"List the message QR codes of a phone number: the 14-character code, prefilled message text and the wa.me deep link. Use ","description":"List the message QR codes of a phone number: the 14-character code, prefilled message text and the wa.me deep link. Use for \"Which WhatsApp QR codes have I created for my number\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phone_number_id":{"description":"WhatsApp Business phone number ID (digits, not the phone number itself) from the account's phone number list.","maxLength":30,"title":"Phone Number Id","type":"string"},"code":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only the QR code with this 14-character identifier.","title":"Code"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many QR codes per page (1 to 25).","title":"Limit"},"after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: paging.cursors.after from the previous answer.","title":"After"}},"required":["phone_number_id"],"title":"list_qr_codesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_qr_code":{"post":{"operationId":"get_qr_code","summary":"Get one message QR code of a phone number: prefilled message text and deep link. Use for \"What message is prefilled in W","description":"Get one message QR code of a phone number: prefilled message text and deep link. Use for \"What message is prefilled in WhatsApp QR code 4O4YGZEG3RIVE1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phone_number_id":{"description":"WhatsApp Business phone number ID (digits, not the phone number itself) from the account's phone number list.","maxLength":30,"title":"Phone Number Id","type":"string"},"qr_code_id":{"description":"The 14-character QR code identifier.","maxLength":20,"title":"Qr Code Id","type":"string"}},"required":["phone_number_id","qr_code_id"],"title":"get_qr_codeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_official_business_account_status":{"post":{"operationId":"get_official_business_account_status","summary":"Get the Official Business Account (green check) application status of a phone number with the explanatory message. Use f","description":"Get the Official Business Account (green check) application status of a phone number with the explanatory message. Use for \"Is my WhatsApp number an approved Official Business Account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phone_number_id":{"description":"WhatsApp Business phone number ID (digits, not the phone number itself) from the account's phone number list.","maxLength":30,"title":"Phone Number Id","type":"string"},"fields":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":"oba_status,status_message","description":"Comma-separated fields: oba_status, status_message.","title":"Fields"}},"required":["phone_number_id"],"title":"get_official_business_account_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_phone_number_settings":{"post":{"operationId":"get_phone_number_settings","summary":"Get the calling settings (status, call icon visibility, video, SIP) and storage configuration of a WhatsApp phone number","description":"Get the calling settings (status, call icon visibility, video, SIP) and storage configuration of a WhatsApp phone number. SIP credentials are never requested. Use for \"Is calling enabled on my WhatsApp Business number\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phone_number_id":{"description":"WhatsApp Business phone number ID (digits, not the phone number itself) from the account's phone number list.","maxLength":30,"title":"Phone Number Id","type":"string"}},"required":["phone_number_id"],"title":"get_phone_number_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}