paydirt_begin_setup
Install voice cancellation feedback and feature request forms in an iOS app by starting setup, reusing an existing app or creating a new one, and connecting Slack during browser authorization.
Instructions
Use this when installing voice cancellation feedback or Suggest a Feature for an iOS app with RevenueCat or StoreKit, and connect Slack during browser authorization. For website-started setup, pass its app_id to reuse the prepared app and delivery settings. Inspect the host first. Without form_plan_confirmed, returns the concise cancellation/Suggest a Feature confirmation and does not start authorization. After confirmation, pass the selected use_cases and placement to receive authorization_url and finish_arguments immediately.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app_id | No | Existing Paydirt app ID, including the ID in a website setup handoff. Reconnect this exact app and reuse its saved Slack/delivery settings instead of creating another app. | |
| app_name | No | Preferred app name to reuse or create during setup | |
| bundle_id | No | Preferred iOS bundle ID to match during setup | |
| use_cases | No | Confirmed feedback experiences to install. The recommended plan is Suggest a Feature plus trial and paid cancellation when subscriptions exist. | |
| app_description | No | Optional app description to save when creating or repairing setup | |
| uses_revenuecat | No | Deprecated compatibility input. Prefer subscription_provider. | |
| feature_placement | No | Developer-confirmed placement for Suggest a Feature, such as settings or after_successful_export. Defaults to settings. | |
| form_plan_confirmed | No | Set true when the developer explicitly requested these voice forms or confirmed the proposed plan. An explicit installation request already confirms its scope; do not ask the same question again. Ask only when the requested forms or placement are ambiguous. | |
| subscription_provider | No | Subscription source of truth discovered in the host app. Use auto only when it could not be resolved before setup. | |
| subscription_product_ids | No | Native StoreKit auto-renewable product IDs. Required for a complete storekit integration. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| message | No | ||
| success | Yes |