{"openapi":"3.1.0","info":{"title":"360dialog (BYOK) API","version":"0.1.0","description":"360dialog (BYOK) lets an AI assistant read your own 360dialog data through the 360dialog API with a key you supply (360dialog API key (one per phone number)). Read-only: 9 tools (get_number_health, list_message_templates, get_message_template, list_flows, get_flow, get_business_profile, get_compliance_info, list_groups, get_business_username). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-dialog360.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-dialog360/docs"},"termsOfService":"https://connectorbay.com/byok-dialog360/terms"},"servers":[{"url":"https://byok-dialog360.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-dialog360/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/get_number_health":{"post":{"operationId":"get_number_health","summary":"Show the health of the WhatsApp number behind the key: quality rating, messaging limit tier, status, name status and whe","description":"Show the health of the WhatsApp number behind the key: quality rating, messaging limit tier, status, name status and whether messages can be sent. Use for \"Is my WhatsApp number healthy and what is its messaging limit tier\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fields":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":"display_phone_number,quality_rating,messaging_limit_tier,status,verified_name,name_status","description":"Extra fields to include next to health_status, comma-separated, for example 'display_phone_number,quality_rating,messaging_limit_tier,status,verified_name'.","title":"Fields"}},"title":"get_number_healthArguments","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_message_templates":{"post":{"operationId":"list_message_templates","summary":"List WhatsApp message templates with name, language, category, approval status, rejection reason and quality score. Use ","description":"List WhatsApp message templates with name, language, category, approval status, rejection reason and quality score. Use for \"Which of my WhatsApp templates are approved or were rejected\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fields":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated fields to return, for example 'id,name,status,category,language'. Leave empty for the default set.","title":"Fields"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return per page (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from paging.cursors.after of the previous answer, to fetch the next page.","title":"After"}},"title":"list_message_templatesArguments","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_message_template":{"post":{"operationId":"get_message_template","summary":"Get one message template by id with its components (header, body, footer, buttons), status and quality score. Use for \"S","description":"Get one message template by id with its components (header, body, footer, buttons), status and quality score. Use for \"Show me the full text and buttons of WhatsApp template 1234567890\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"template_id":{"description":"Id of the message template (from list_message_templates).","maxLength":200,"title":"Template Id","type":"string"}},"required":["template_id"],"title":"get_message_templateArguments","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_flows":{"post":{"operationId":"list_flows","summary":"List WhatsApp Flows with name, status (draft, published, deprecated, blocked, throttled), categories and validation erro","description":"List WhatsApp Flows with name, status (draft, published, deprecated, blocked, throttled), categories and validation errors. Use for \"Which WhatsApp Flows are published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return per page (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from paging.cursors.after of the previous answer, to fetch the next page.","title":"After"}},"title":"list_flowsArguments","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_flow":{"post":{"operationId":"get_flow","summary":"Get one WhatsApp Flow by id: status, categories, JSON and data API versions and validation errors. Use for \"What is the ","description":"Get one WhatsApp Flow by id: status, categories, JSON and data API versions and validation errors. Use for \"What is the status of WhatsApp Flow 5551234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"flow_id":{"description":"Id of the Flow (from list_flows).","maxLength":200,"title":"Flow Id","type":"string"}},"required":["flow_id"],"title":"get_flowArguments","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_business_profile":{"post":{"operationId":"get_business_profile","summary":"Get the WhatsApp Business profile of the number: about text, description, address, email, websites and business vertical","description":"Get the WhatsApp Business profile of the number: about text, description, address, email, websites and business vertical. Use for \"What does my WhatsApp business profile say\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fields":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":"about,address,description,email,websites,vertical","description":"Comma-separated profile fields to return.","title":"Fields"}},"title":"get_business_profileArguments","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_compliance_info":{"post":{"operationId":"get_compliance_info","summary":"Get the business compliance details registered for the number: entity name and type, registration flag and customer care","description":"Get the business compliance details registered for the number: entity name and type, registration flag and customer care contacts. Use for \"What compliance information is registered for my WhatsApp number\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_compliance_infoArguments","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_groups":{"post":{"operationId":"list_groups","summary":"List the active WhatsApp groups of the number with id, subject and creation time (Groups API accounts only). Use for \"Wh","description":"List the active WhatsApp groups of the number with id, subject and creation time (Groups API accounts only). Use for \"Which WhatsApp groups is my business number in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1024,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many groups to return (1 to 1024).","title":"Limit"},"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from paging.cursors.after of the previous answer, to fetch the next page.","title":"After"}},"title":"list_groupsArguments","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_business_username":{"post":{"operationId":"get_business_username","summary":"Get the WhatsApp business username of the number and its status. Use for \"Does my WhatsApp business number have a userna","description":"Get the WhatsApp business username of the number and its status. Use for \"Does my WhatsApp business number have a username\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_business_usernameArguments","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}}}}