# Botbye | Documentation ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.botbye.com/_mcp/server ## Docs - [Introduction](https://api-docs.botbye.com/bot-bye-api/introduction.md) ## API Docs - BotBye API > Profile > Account Profiles [get profile](https://api-docs.botbye.com/bot-bye-api/profile/account-profiles/get-profile.md) - BotBye API > Profile > Account Profiles [update profile](https://api-docs.botbye.com/bot-bye-api/profile/account-profiles/update-profile.md) - BotBye API > Management > Acl [get tree](https://api-docs.botbye.com/bot-bye-api/management/acl/get-tree.md) - BotBye API > Management > Acl [list groups](https://api-docs.botbye.com/bot-bye-api/management/acl/list-groups.md) - BotBye API > Management > Acl [create group](https://api-docs.botbye.com/bot-bye-api/management/acl/create-group.md) - BotBye API > Management > Acl [update group](https://api-docs.botbye.com/bot-bye-api/management/acl/update-group.md) - BotBye API > Management > Acl [delete group](https://api-docs.botbye.com/bot-bye-api/management/acl/delete-group.md) - BotBye API > Management > Account Members [list](https://api-docs.botbye.com/bot-bye-api/management/account-members/list.md) - BotBye API > Management > Account Members [find](https://api-docs.botbye.com/bot-bye-api/management/account-members/find.md) - BotBye API > Management > Account Members [remove](https://api-docs.botbye.com/bot-bye-api/management/account-members/remove.md) - BotBye API > Management > Account Members [invite](https://api-docs.botbye.com/bot-bye-api/management/account-members/invite.md) - BotBye API > Management > Account Members [cancel invitation](https://api-docs.botbye.com/bot-bye-api/management/account-members/cancel-invitation.md) - BotBye API > Management > Account Members [update ACL](https://api-docs.botbye.com/bot-bye-api/management/account-members/update-acl.md) - BotBye API > Privacy > Privacy [get customer privacy data](https://api-docs.botbye.com/bot-bye-api/privacy/privacy/get-customer-privacy-data.md) - BotBye API > Privacy > Privacy [purge customer data](https://api-docs.botbye.com/bot-bye-api/privacy/privacy/purge-customer-data.md) - BotBye API > Privacy > Privacy [get end user privacy data](https://api-docs.botbye.com/bot-bye-api/privacy/privacy/get-end-user-privacy-data.md) - BotBye API > Privacy > Privacy [purge end user data](https://api-docs.botbye.com/bot-bye-api/privacy/privacy/purge-end-user-data.md) - BotBye API > Protection > Projects [find all](https://api-docs.botbye.com/bot-bye-api/protection/projects/find-all.md) - BotBye API > Protection > Projects [create](https://api-docs.botbye.com/bot-bye-api/protection/projects/create.md) - BotBye API > Protection > Projects [find](https://api-docs.botbye.com/bot-bye-api/protection/projects/find.md) - BotBye API > Protection > Projects [delete](https://api-docs.botbye.com/bot-bye-api/protection/projects/delete.md) - BotBye API > Protection > Projects [partial update](https://api-docs.botbye.com/bot-bye-api/protection/projects/partial-update.md) - BotBye API > Protection > Project Members [list](https://api-docs.botbye.com/bot-bye-api/protection/project-members/list.md) - BotBye API > Protection > Project Members [find](https://api-docs.botbye.com/bot-bye-api/protection/project-members/find.md) - BotBye API > Protection > Project Members [remove](https://api-docs.botbye.com/bot-bye-api/protection/project-members/remove.md) - BotBye API > Protection > Project Members [invite](https://api-docs.botbye.com/bot-bye-api/protection/project-members/invite.md) - BotBye API > Protection > Project Members [cancel invitation](https://api-docs.botbye.com/bot-bye-api/protection/project-members/cancel-invitation.md) - BotBye API > Protection > Project Members [update ACL](https://api-docs.botbye.com/bot-bye-api/protection/project-members/update-acl.md) - BotBye API > Protection > Custom Rules [find](https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/find.md) - BotBye API > Protection > Custom Rules [delete](https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/delete.md) - BotBye API > Protection > Custom Rules [update order](https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/update-order.md) - BotBye API > Protection > Custom Rules [set isActive](https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/set-is-active.md) - BotBye API > Protection > Custom Rules [create](https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/create.md) - BotBye API > Protection > Custom Rules [update](https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/update.md) - BotBye API > Protection > Rate Limiters [find](https://api-docs.botbye.com/bot-bye-api/protection/rate-limiters/find.md) - BotBye API > Protection > Rate Limiters [delete](https://api-docs.botbye.com/bot-bye-api/protection/rate-limiters/delete.md) - BotBye API > Protection > Rate Limiters [update order](https://api-docs.botbye.com/bot-bye-api/protection/rate-limiters/update-order.md) - BotBye API > Protection > Rate Limiters [set isActive](https://api-docs.botbye.com/bot-bye-api/protection/rate-limiters/set-is-active.md) - BotBye API > Protection > Rate Limiters [create](https://api-docs.botbye.com/bot-bye-api/protection/rate-limiters/create.md) - BotBye API > Protection > Rate Limiters [update](https://api-docs.botbye.com/bot-bye-api/protection/rate-limiters/update.md) - BotBye API > Protection > Metric Definitions [list](https://api-docs.botbye.com/bot-bye-api/protection/metric-definitions/list.md) - BotBye API > Protection > Metric Definitions [create](https://api-docs.botbye.com/bot-bye-api/protection/metric-definitions/create.md) - BotBye API > Protection > Metric Definitions [find](https://api-docs.botbye.com/bot-bye-api/protection/metric-definitions/find.md) - BotBye API > Protection > Metric Definitions [update](https://api-docs.botbye.com/bot-bye-api/protection/metric-definitions/update.md) - BotBye API > Protection > Metric Definitions [delete](https://api-docs.botbye.com/bot-bye-api/protection/metric-definitions/delete.md) - BotBye API > Protection > Metric Rule Definitions [list](https://api-docs.botbye.com/bot-bye-api/protection/metric-rule-definitions/list.md) - BotBye API > Protection > Metric Rule Definitions [create](https://api-docs.botbye.com/bot-bye-api/protection/metric-rule-definitions/create.md) - BotBye API > Protection > Metric Rule Definitions [find](https://api-docs.botbye.com/bot-bye-api/protection/metric-rule-definitions/find.md) - BotBye API > Protection > Metric Rule Definitions [update](https://api-docs.botbye.com/bot-bye-api/protection/metric-rule-definitions/update.md) - BotBye API > Protection > Metric Rule Definitions [delete](https://api-docs.botbye.com/bot-bye-api/protection/metric-rule-definitions/delete.md) - BotBye API > Protection > Dimension Thresholds [create threshold](https://api-docs.botbye.com/bot-bye-api/protection/dimension-thresholds/create-threshold.md) - BotBye API > Protection > Dimension Thresholds [update threshold](https://api-docs.botbye.com/bot-bye-api/protection/dimension-thresholds/update-threshold.md) - BotBye API > Protection > Dimension Thresholds [delete threshold](https://api-docs.botbye.com/bot-bye-api/protection/dimension-thresholds/delete-threshold.md) - BotBye API > Protection > Validation Events [events](https://api-docs.botbye.com/bot-bye-api/protection/validation-events/events.md) - BotBye API > Protection > Good Bots [check](https://api-docs.botbye.com/bot-bye-api/protection/good-bots/check.md) - BotBye API > Protection > Compromised Users [list](https://api-docs.botbye.com/bot-bye-api/protection/compromised-users/list.md) - BotBye API > Protection > CAPTCHA Records [list](https://api-docs.botbye.com/bot-bye-api/protection/captcha-records/list.md) - BotBye API > Protection > Overview [events overview](https://api-docs.botbye.com/bot-bye-api/protection/overview/events-overview.md) - BotBye API > Protection > Overview [declined events count](https://api-docs.botbye.com/bot-bye-api/protection/overview/declined-events-count.md) - BotBye API > Protection > Overview [declined events summary](https://api-docs.botbye.com/bot-bye-api/protection/overview/declined-events-summary.md) - BotBye API > Protection > Multi Accounts [find](https://api-docs.botbye.com/bot-bye-api/protection/multi-accounts/find.md) - BotBye API > Protection > Multi Accounts [findById](https://api-docs.botbye.com/bot-bye-api/protection/multi-accounts/find-by-id.md) - BotBye API > Protection > Response Extra Fields [list available fields](https://api-docs.botbye.com/bot-bye-api/protection/response-extra-fields/list-available-fields.md) - BotBye API > Protection > Response Extra Fields [get project fields](https://api-docs.botbye.com/bot-bye-api/protection/response-extra-fields/get-project-fields.md) - BotBye API > Anti-Phishing > Project Domains [create domains](https://api-docs.botbye.com/bot-bye-api/anti-phishing/project-domains/create-domains.md) - BotBye API > Anti-Phishing > Project Domains [delete domains](https://api-docs.botbye.com/bot-bye-api/anti-phishing/project-domains/delete-domains.md) - BotBye API > Anti-Phishing > Project Domains [update domain statuses](https://api-docs.botbye.com/bot-bye-api/anti-phishing/project-domains/update-domain-statuses.md) - BotBye API > Anti-Phishing > Project Domains [list domains](https://api-docs.botbye.com/bot-bye-api/anti-phishing/project-domains/list-domains.md) - BotBye API > Anti-Phishing > Project Domains [domain exists](https://api-docs.botbye.com/bot-bye-api/anti-phishing/project-domains/domain-exists.md) - BotBye API > Anti-Phishing > Project Domains [delete domain](https://api-docs.botbye.com/bot-bye-api/anti-phishing/project-domains/delete-domain.md) - BotBye API > Anti-Phishing > Project Domains [update domain status](https://api-docs.botbye.com/bot-bye-api/anti-phishing/project-domains/update-domain-status.md) - BotBye API > Anti-Phishing > Report Phishing [report](https://api-docs.botbye.com/bot-bye-api/anti-phishing/report-phishing/report.md) - BotBye API > Challenges [report](https://api-docs.botbye.com/bot-bye-api/challenges/report.md) - BotBye API > Challenges [revoke grant](https://api-docs.botbye.com/bot-bye-api/challenges/revoke-grant.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://api-docs.botbye.com/openapi.json) - [OpenAPI YAML](https://api-docs.botbye.com/openapi.yaml)