InAppify REST API reference
Complete server-to-server REST API reference covering authentication, endpoints, parameters, responses, errors, and PHP examples.
The InAppify REST API securely connects your backend to one project's customers, offerings, promotional entitlements, and discount codes. It is not the dashboard's internal API or the client SDK API.
| Operation | Method and path | Required ability |
|---|---|---|
| Get or create subscriber | GET /subscribers/{app_user_id} | customers:read |
| Delete subscriber | DELETE /subscribers/{app_user_id} | customers:delete |
| Sync attributes | POST /subscribers/{app_user_id}/attributes | customers:attributes:write |
| Get offerings | GET /subscribers/{app_user_id}/offerings | offerings:read |
| Set offering override | POST /subscribers/{app_user_id}/offerings/{offering_identifier}/override | offerings:override:write |
| Remove offering override | DELETE /subscribers/{app_user_id}/offerings/override | offerings:override:delete |
| Grant promotional entitlement | POST /subscribers/{app_user_id}/entitlements/{entitlement_identifier}/promotional | entitlements:promotional:grant |
| Revoke promotional entitlements | POST /subscribers/{app_user_id}/entitlements/{entitlement_identifier}/revoke_promotionals | entitlements:promotional:revoke |
| Generate discount code | POST /services/generate-discount | discount:generate |
Use https://api.example.com/api/v1 as the documented placeholder base URL and replace its domain with the API domain shown by InAppify.
Continue with authentication, responses and errors, subscribers, offerings, promotional entitlements, discounts, and PHP examples.
Never embed a secret REST API key in a mobile app, public website, or client-side bundle.