Publisher Suggestions: List
Retrieve suggestions publishers have submitted for the Locations in an account
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: "WAITING_ON_CUSTOMER" "ACCEPTED" "REJECTED" "EXPIRED" When specified, only Publisher Suggestions with the provided statuses will be returned Example: WAITING_ON_CUSTOMER,EXPIRED |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "suggestions": [
- {
- "id": "string",
- "publisherId": "string",
- "locationId": "string",
- "dateCreated": "2019-08-24",
- "dateResolved": "2019-08-24",
- "fieldName": "string",
- "status": "WAITING_ON_CUSTOMER",
- "resolvedBy": "string",
- "originalContent": "string",
- "suggestedContent": "string"
}
]
}
}Publisher Suggestions: Get
Fetches details of a specific Publisher Suggestion
path Parameters
| accountId required | string |
| suggestionId required | string |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string",
- "publisherId": "string",
- "locationId": "string",
- "dateCreated": "2019-08-24",
- "dateResolved": "2019-08-24",
- "fieldName": "string",
- "status": "WAITING_ON_CUSTOMER",
- "resolvedBy": "string",
- "originalContent": "string",
- "suggestedContent": "string"
}
}Publisher Suggestions: Update
Accept or reject a Publisher Suggestion.
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 |
| suggestionId required | string |
query Parameters
| v required | string A date in |
| status required | string Enum: "ACCEPTED" "REJECTED" The status of the Publisher Suggestion |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}