Duplicates: List
Retrieve Duplicates for an account
If the v parameter is 20180802 or later: only duplicates of live listings (status: LIVE) will be included
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
| limit | integer <= 50 Default: 10 Number of results to return |
| offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
| locationIds | Array of strings Defaults to all account locations with a Listings subscription. Example: loc123,loc456,loc789 |
| publisherIds | Array of strings List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account. Example: MAPQUEST,FACEBOOK |
| statuses | Array of strings Items Enum: "POSSIBLE_DUPLICATE" "SUPPRESSION_REQUESTED" "SUPPRESSED" "UNAVAILABLE" When specified, only Duplicates with the provided statuses will be returned Example: POSSIBLE_DUPLICATE,SUPPRESSION_REQUESTED |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "duplicates": [
- {
- "id": "string",
- "publisherId": "string",
- "locationId": "string",
- "url": "string",
- "name": "string",
- "address": "string",
- "phone": "string",
- "latitude": "string",
- "longitude": "string",
- "status": "POSSIBLE_DUPLICATE",
- "suppressionType": "REDIRECT",
- "unavailableReasons": [
- {
- "code": "string",
- "reason": "string"
}
]
}
]
}
}Duplicates: Create
Creates a new Duplicate with status SUPPRESSION_REQUESTED.
NOTE: When sending requests to this endpoint, you must provide your Yext user ID in the Yext-User-Id header.
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
| locationId | string An account location ID with a Listings subscription. |
| publisherId required | string |
| url required | string URL of the Duplicate listing |
Responses
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string"
}
}Duplicates: Delete
Indicates that a Duplicate should be ignored.
NOTE: When sending requests to this endpoint, you must provide your Yext user ID in the Yext-User-Id header.
path Parameters
| accountId required | string |
| duplicateId required | string |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}Duplicates: Suppress
Request suppression of a Duplicate.
NOTE: When sending requests to this endpoint, you must provide your Yext user ID in the Yext-User-Id header.
path Parameters
| accountId required | string |
| duplicateId required | string |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}