Suggestion: Upsert

Create or update a suggestion via API.

NOTE:

  • App must have Create Suggestions: Read/Write permission to utilize endpoint.
  • If a suggestion already exists from your app on the specified field, the suggestion will be updated.
  • Suggestions on ECLs are not currently supported.
path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

format
string >= 0 characters
Default: "markdown"

The formatting language used to parse rich text field values. Present if and only if the field is of type “Rich Text."

Valid values:

  • markdown
  • html
  • none
Request Body schema: application/json

The suggestion to be upserted

required
object

An object containing information about a suggestion for a single field on a single entity. Only valid if the suggestion is for a field on a single entity.

Responses

Request samples

Content type
application/json
{
  • "entityFieldSuggestion": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Suggestions: List

Retrieve a list of Suggestions within an account

NOTE:

  • App must have either Create Suggestions: Read permission or Manage Suggestions: Read permission to utilize endpoint.
  • If App only has Create Suggestions: Read permission, only Suggestions created by the App in question will be returned.
  • Suggestions on ECLs are not supported.
path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

format
string >= 0 characters
Default: "markdown"

The formatting language used to parse rich text field values. Present if and only if the field is of type “Rich Text."

Valid values:

  • markdown
  • html
  • none
entityIds
string >= 0 characters

Comma-separated list of entity IDs to pull suggestions for. Defaults to all entities in the account if unspecified.

entityUids
string >= 0 characters

Comma-separated list of entity UIDs (formerly known as Yext IDs) to pull suggestions for. Defaults to all entities in the account if unspecified.

statuses
string >= 0 characters

Comma-separated list of statuses of suggestions to pull. Defaults to all, but can be any of APPROVED, REJECTED, PENDING, CANCELED.

limit
number multiple of 1 <= 50
Default: "10"

Number of results to return. Default to 10, can go up to 50.

pageToken
string >= 0 characters

If a response to a previous request contained the nextPageToken field, pass that field's value as the pageToken parameter to retrieve the next page of data.

sortBy
string >= 0 characters

Field and sort direction to order results by. The ordering should be a list with one element in the format of {"field_name": "sort_direction"}, where sort_direction is either "ascending" or "descending".

This param value needs to be URL encoded.

The following fields are supported for sorting:

  • uid
  • lastUpdatedDate

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Suggestion: Cancel

Cancel a suggestion which was submitted by the App.

NOTE:

  • App must have Create Suggestions: Read/Write permission to utilize endpoint.
  • Suggestions can only be canceled by the submitter.
path Parameters
accountId
required
string
suggestionUid
required
string

The Yext-generated unique identifier for the Suggestion.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Suggestion: Get

Retrieve information for a Suggestion with a given ID

NOTE:

  • App must have either Create Suggestions: Read permission or Manage Suggestions: Read permission to utilize endpoint.
  • If App only has Create Suggestions: Read permission, only Suggestions created by the App in question will be returned.
  • Suggestions on ECLs are not supported.
path Parameters
accountId
required
string
suggestionUid
required
string

The Yext-generated unique identifier for the Suggestion.

query Parameters
v
required
string

A date in YYYYMMDD format.

format
string >= 0 characters
Default: "markdown"

The formatting language used to parse rich text field values. Present if and only if the field is of type “Rich Text."

Valid values:

  • markdown
  • html
  • none

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {