Companion Apps API: Sample Flows

This article presents a possible use case and corresponding sample flow that you can support. It provides a useful starting point as you plan your implementation.

Prepare a site to use app-provided customization features

Before enabling app-provided customization features on a site, you may need to make sure the site has a companion app installed and ready to use.

To prepare a site to use app-provided customization features:

1. Call Get Or Create Companion App to retrieve the current site's companion app, creating and installing it if it doesn't already exist.
2. If the call returns an installation error, call the method again to retry installation. The companion app created by the failed call is kept.
3. Check the returned companion app's status and wait to continue until the status is READY.
4. Enable the app-provided customization functionality on the site.