API Overview

Looking for Legacy V1 API Documentation?

The Botsi API is a developer-first platform designed to interact with the Botsi AI Pricing Models, profile management, paywall selection, and event tracking.

Get the Botsi Postman Collection here: Postman Collection

Base URL: https://api.botsi.com/v2

Profile management#

Endpoint	Method	Purpose
Create a Profile	`POST`	Create the record Botsi keeps for one of your users
Get a Profile	`GET`	Read a Profile's current access, subscriptions, and custom attributes
Update a Profile	`PATCH`	Change a Profile's details after it's created
Record Apple Consumption Consent	`PATCH`	Record whether the user agreed to share consumption data with Apple
Add Custom Attributes	`POST`	Add one or more attributes to a Profile
Update Custom Attributes	`PUT`	Change an existing attribute

Fetch Paywalls#

Endpoint	Method	Purpose
Fetch Paywall	`POST`	Retrieve a paywall intelligently selected for a user profile and placement

Events and purchases#

Endpoint	Method	Purpose
Send Paywall Shown Event	`POST`	Record Paywall exposure
Validate Apple Store Purchase	`POST`	Validate an App Store purchase
Validate Google Play Store Purchase	`POST`	Validate a Google Play purchase
Restore Apple Store Purchases	`POST`	Grant a Profile the access its App Store subscription carries
Restore Google Play Subscriptions	`POST`	Grant a Profile the access its Google Play subscriptions carry

Inbound revenue and subscription events from each billing platform are documented on that platform's own page. Notification URLs covers the URL format they share.

App Store Server Notifications

Google Play Real-Time Developer Notifications

Stripe Webhooks

Shopify Webhooks

Custom Webhooks