Get audience suggestions

get /text/Suggestion/Audience
This endpoint generates a list of suggested audience categories based on the provided product or category data. Audience suggestions are generated based on the type of product and other associated data.

Requirements

Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Parameter Name Type Description
storeId string, optional

The storefront ID used to differentiate images or products across different stores.
type string, required Defines whether the request is for a "Product" or "Category". Defaults to "Product".
recordId string, required The unique identifier of the product or category.
text array of strings, optional A multi-value parameter where the first value is typically the product name or other key data points used to generate suggestions.
clearAltText boolean, optional Whether to clear the alternative text suggestions (defaults to false).

Example API Request

Response

200
400
404
500
//The response provides a list of suggested audience categories for the product or category based on the inputs.
//This error occurs if the request is not correctly formatted or required fields are missing.
//This error occurs if the specified product, store, or audience data is not found.
//The server encountered an error when processing the request.