SUPPRESS This call allows Yext to suppress duplicate or invalid listings. If a listing is SUPPRESSed, we expect you to exclude the listing from your site's search results. Going to the SUPPRESSed listing's URL should result in either a 404 error or a redirect to the listing specified in canonicalListingId. Only non-Yext listings are suppressed: We only suppress listings that are not powered by Yext. We do not suppress listings that we sync data to. NOTES: A SUPPRESSed listing should be: a. marked as suppressed in your SEARCH API response, OR b. excluded from your SEARCH API response. An un-SUPPRESSed listing should: a. have an AVAILABLE status in your SEARCH API response, AND b. revert the listing back to its original state (i.e., not redirect or lead to a 404 error page). The call should be idempotent; for example, you should report success and do nothing if Yext attempts to suppress a listing that is already suppressed. Requirements In order to hide duplicate or invalid listings, Yext may indicate to the publisher that a listing must be suppressed, optionally providing the id of a listing that it duplicates (the “canonical” listing). The publisher must comply within 24 hours by taking the following actions: The publisher must exclude the suppressed listing from their search index. If a canonical listing ID is provided, the publisher must place a redirect to send users that access the suppressed listing’s profile page to the canonical listing’s profile page. Conversely, Yext may indicate to the publisher that a listing suppression should be reverted. Request Properties Property Value Request method POST https://partner.com/powerlistings/suppress URL Your choice of: Content-type application/json application/xml Body JSON Schema: We have JSON Schema files that you can use to validate your requests. For more information, see the JSON Schema section. The request will be a JSON or XML document with the following properties. Name Required? listingId Yes Description The partner listing ID that should be suppressed (or un-suppressed) A boolean value: suppress Yes true, if the listing should be suppressed false, if the listing should be un-suppressed A partner listing ID. When suppressing a listing, this value may be provided. If it is provided, the partner is canonicalListingId No expected to redirect the profile page specified in listingId to the one specified in canonicalListingId. A human-provided explanation of the suppression. For example, "Acme has given reason us a comprehensive list of locations, and these (manually- No identified) Acme listings were not present." Examples JSON XML Response Return a status code indicating success or failure. If the request failed, an explanation should be included in the body. Status Codes Status Code Condition Example 200 OK You successfully recorded the suppression. 400 BAD REQUEST Yext sent a malformed request. 404 NOT FOUND The specified listing does not exist. 409 CONFLICT The listing is blocked for business reasons. Pre-existing / paid relationship 5xx SERVER ERROR Temporary error -- Yext should try again later. Server outage, etc. Body The content of the response body depends on whether the request was successful. Successful Suppression The body of the SUPPRESS response should be empty. Failed Suppression If the suppression attempt failed, the body of the SUPPRESS response (data) should describe why the suppression was not successful. Field Required? Description Possible values: status Yes BLOCKED Issues that are causing the status to be BLOCKED issues Yes Each issue has a description describing why the suppression was not successful. An XML example of a failed suppression response appears below.– <data> <status>BLOCKED</status> <issues> <issue> <description>Suppression attempted unsuccessful because the listing is claimed by an existing advertiser.</description> </issue> </issues> </data>