We are looking for a REST or GraphQL API that allows us to programmatically toggle a switch in the theme, specifically within App Embeds.
Could you please let us know if such an API currently exists, if there are any references available, or if there are any plans to release this functionality in the future?
Hey @Viral_Mandaliya - @kyle_liu is correct here, at the moment there isn’t an API or a way to programatically toggle an App Embed on or off.
Just out of curiosity, would you be able to share your use case here in the thread? I can’t guarantee anything, but I can definitely put through a feature request for you so that we can look into implementing this in the future - hope to hear from you soon!
When a merchant installs our app, they follow a setup process within the app. At one stage, they are required to navigate to Shopify > App Embeds, enable the theme app extension, and click Save on the same Shopify page. After that, they have to manually return to our app to continue the setup.
If there were an API available to programmatically enable “App Embeds” merchants wouldn’t need to leave our app during the setup process. This would significantly reduce the number of steps and improve the overall onboarding experience.
Additionally, we have observed that one of the existing apps is able to enable this automatically after installation. App name is “Boost AI Search & Filter”
Thanks @Viral_Mandaliya! I’m not completely certain how the Boost AI folks are enabling this on their end, but I do know some folks have used this workaround for a while:
I’ll set up a feature request report for you on this though, since I definitely agree it would make sense to offer a way to do this. I can’t guarantee anything, but I have seen feature requests I’ve put through be added in production, so it can happen
At the moment, we are following the same approach redirecting the merchant to Shopify via a deep link, where they only need to click the Save button.
Thank you for considering this as a feature request. It would be great if the Shopify team could provide this functionality as soon as possible, as it would significantly improve the user experience for all app users.
No worries Viral - definitely understand where you’re coming from. Just confirming I’ve sent that feature request through on my end here - let me know if I can help with anything else!
Hey @Viral_Mandaliya, thanks for following up on this! I don’t have any updates to share at the moment, but I can reach out to our product team to see if we can share any more information or confirm if this is something that’s on our roadmap. I’ll loop back with you here once I have more info to share
Hey @Viral_Mandaliya, just following up here. I checked in with our product team and there isn’t an API to programmatically enable App Embeds on the roadmap right now. I definitely understand that’s not the answer you were hoping for though.
For now, the supported approach is to deep-link merchants into the Theme Editor with your app embed pre-selected so they only need to click Save:
https://{shop}.myshopify.com/admin/themes/current/editor?context=apps&activateAppId={app_api_key}/{extension_handle}
That said, the feature request is still logged on our end so it’s something that our developers are aware of, but not looking at implementing at the moment.
Thanks again for bringing this up, hopefully we will see something like this implemented in the future for sure. Let me know if I can clarify anything or help out further as always, happy to help!