Flexible Action Links
Overview
Flexible action links navigate users to a website to complete an action, such as ordering food or making a reservation. They are the same as quicklinks except that they don't require an Apple App Store URL link.
This topic describes creating flexible action links through the Apple Business Location API.
Requirements
- Partners may add flexible action links on behalf of an organization after Share Access is set up.
- Multiple flexible action links may be provided per location, however, only one flexible action link is allowed for each action.
- Flexible action link URL must be HTTPS.
- All flexible action links are validated by Apple to ensure relevance for the location category and that they are accessible to the user.
For additional requirements, see Business API > Location > Quicklinks > Quicklinks Without App Store URL (Flexible Action Links).
Create Flexible Action Links
- Create or update a location and provide the flexible action link for use in the Apple Maps place card. See Business API > Location > Create/Update.
- Action Link Details > Quicklinks > Quicklinks Without App Store URL (Flexible Action Links).
- Do not specify
appStoreUrl.
- Get the list of available calls-to-action for a location using the Apple-generated location ID from Step 1. See Business API > Location > Call-to-Action. Availability is controlled by:
- Location category.
- Action links from all available sources which have been merged into the conflated record.
-
Optionally, set the order of providers of all action links. See Business API > Location > Order CTA Providers.
-
Check notifications. See Business API > Events > Get Notifications.
- Flexible action links are validated when submitted and periodically, thereafter, to ensure that links are valid and accessible to the user.
- If a flexible action link is rejected, investigate the reason for rejection, fix the issue, then resubmit the location.
Common Rejection Reasons
Some common reasons include:
- URL shorteners.
- URLs that result in HTTP errors (non HTTP OK response).
- URLs that have connection timeouts.
- URLs with content > 1 MB.
- Certificate errors.
- HTTPS and TLS errors.
- Exceeds the maximum number of redirects for the flexible action link. The maximum is two, including the redirect to the final page.