From 8a6674755e74d7cd84b7f6d908ceebd5fd431359 Mon Sep 17 00:00:00 2001 From: Sojan Jose Date: Tue, 15 Jul 2025 20:44:33 -0700 Subject: [PATCH] chore: Update FAQ for outdated api documentation --- api-reference/introduction.mdx | 6 ++++++ contributing-guide/chatwoot-apis.mdx | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 261a53cb..eb9c0d4c 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -61,3 +61,9 @@ Platform APIs cannot access accounts or users created via the Chatwoot UI, or by ```ruby PlatformAppPermissible.create!(platform_app: PlatformApp.find(1), permissible: Account.find(1)) ``` + +### What should I do if the API documentation appears outdated? + +If you encounter discrepancies between the API documentation and actual API behavior, we recommend inspecting the actual requests made by the Chatwoot UI through your browser's developer console Network tab to see the exact request format and payload structure that works with the current API, then replicate the same request structure in your integration. + +You can contribute back by submitting a [pull request](/contributing-guide/api-documentation) with documentation corrections or by [raising an issue](https://github.com/chatwoot/chatwoot/issues) in our GitHub repository to help keep our API documentation current for everyone. diff --git a/contributing-guide/chatwoot-apis.mdx b/contributing-guide/chatwoot-apis.mdx index 716e2b70..3581c838 100644 --- a/contributing-guide/chatwoot-apis.mdx +++ b/contributing-guide/chatwoot-apis.mdx @@ -58,3 +58,9 @@ Platform APIs cannot access accounts or users created via the Chatwoot UI, or by ```ruby PlatformAppPermissible.create!(platform_app: PlatformApp.find(1), permissible: Account.find(1)) ``` + +#### What should I do if the API documentation appears outdated? + +If you encounter discrepancies between the API documentation and actual API behavior, we recommend inspecting the actual requests made by the Chatwoot UI through your browser's developer console Network tab to see the exact request format and payload structure that works with the current API, then replicate the same request structure in your integration. + +You can contribute back by submitting a [pull request](/contributing-guide/api-documentation) with documentation corrections or by [raising an issue](https://github.com/chatwoot/chatwoot/issues) in our GitHub repository to help keep our API documentation current for everyone.