Step 3: Opt-in Your Entities

For listings that are opted-out, you can use the Listings: Opt In endpoint to begin syncing data between the entity and the Publisher.

Endpoint Information:


URL	https://api.yextapis.com/v2/accounts/{accountId}/listings/listings
Permissions	Listings: READ
Description	Opts specified entities into designated Publishers.

Example Request:


PUT	https://api.yextapis.com/v2/accounts/{accountId}/listings/listings/optin?api_key={API_KEY}&v=20210504&locationIds=[location123,location456]&publisherIds=[YELP]

Things to note:

You can specify a maximum of 100 [locationId, publisherId] combinations to opt in.
If the locationIds parameter is not included, it defaults to all entities with an active Listings subscription.
If the publisherIds parameter is not included, it defaults to all publishers available to the account.

Feedback

<% elem.innerText %>