Step 4: Opt-out your Entities

If at any point you’d like to stop sending entity updates to a Publisher, you can use the Listings: Opt Out endpoint.

Endpoint Information:

URL https://api.yext.com/v2/accounts/{accountId}/listings/listings/optOUT
Permissions Listings: WRITE
Description Opts specified entities out of service on designated Publishers.

Example Request:

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.
  • Opting out an entity does not delete its listing from the Publisher’s site. When an entity is opted out, new changes made to the entity will no longer be sent to the Publisher.