Skip to main content

Manage location API processes

Get Calls-to-Action​

Description​

Use Get CTAs API to retrieve a list of available calls-to-action for a PUBLISHED location. Then, optionally, use the Order CTA Providers API to reorder the list of available CTAs. After retrieving a notification about the successful publication of a reordered list of CTA providers, use the Update Location API to pass your chosen callToAction.

Preconditions​

  • Location is PUBLISHED

Get CTAs​

  1. API user calls Get CTAs to request a list of available calls-to-action (CTAs)
  2. System validates request
  3. If no exceptions, then 200 OK and response body with available CTAs is returned
  4. API user reads the list of available CTAs

Order CTA Providers (Optional Subflow)​

  1. API user calls Order CTA Providers API to request reordering of the list
  2. System synchronously validates the request
  3. If no exceptions, then 204 No Content (Success) is returned
  4. System asynchronously validates the request
  5. If no exceptions, then Feedback is not generated
  6. System "listens" for event indicating that list is "live"
  7. System captures Feedback and generates Notification when event message is received
  8. Periodically API user requests Notifications
  9. Notification indicates that publication of list is successful
tip

Poll for notifications every 15 minutes

Update Location​

  1. After reading a Notification about the successful publication of a reordered list, the API user requests to update a location resource. Included in the request is the API user's chosen callToAction for use on the place card.
  2. System validates request
  3. System synchronously validates partner data
  4. If no exceptions, then 200 OK is returned
  5. System asynchronously validates partner data
  6. If no exceptions, then Feedback is not generated
  7. System "listens" for event indicating resource is "live"
  8. System captures Feedback and generates Notification when event message is received
  9. Periodically API user requests Notifications
  10. Notification indicates that publication of resource is successful
Copyright © 2026 Apple Inc. All rights reserved.