- WriteText.ai API Overview
- Getting started
- CREDIT ENDPOINTS
- GENERATE ENDPOINTS
- GETText generation rules and limits
- GETAvailable text generation tones
- GETText generation styles
- GETTarget audiences for text generation
- GETAvailable text types for generation
- GETText generation history
- GETStatus of generated texts
- GETGenerated text for multiple records
- GETActive generation requests
- GETDetails of a specific generation request
- POSTText generation
- POSTCancel a bulk generation request
- POSTUpdate generated text fields
- POSTArchive record
- IMAGE ENDPOINTS
- KEYWORDS ENDPOINTS
- GETKeyword optimization data
- POSTOptimize keywords for text
- DELETEKeyword optimization
- PUTKeyword optimization
- GETKeyword optimization list
- PUTKeyword optimization data
- DELETERanking keywords
- PUTKeyword optimization pipelines
- GETKeyword state
- POSTKeyword pipeline
- DELETEKeyword pipeline
- POSTRestore keyword pipeline
- POSTAdd triggers to keyword pipeline
- POSTAdd triggers to a specific keyword pipeline
- POSTLock a specific keyword pipeline
- POSTUnlock a specific keyword pipeline
- GETPipeline snapshots
- PUTUpdate or create a snapshot
- POSTAdd manual keywords
- GETManual keywords
- REVIEW ENDPOINTS
- SUGGESTION ENDPOINTS
- TEMPLATE SETTINGS
- TOKEN
Submit audience data for suggestions
post
/text/Suggestion/Audience
This endpoint updates selected audience suggestions for a product or category based on previously generated suggestions.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Request parameters
| Parameter Name | Type | Description |
|---|---|---|
| storeId | string, required | The storefront ID used to differentiate audiences or products across different stores. |
| type | string, required | Defines whether the update is for a "Product" or "Category". Defaults to "Product". |
| recordId | string, required | The unique identifier of the product or category. |
| text | array of strings, required | A multi-value parameter where the first value is typically the product name or other key data points used to generate suggestions. |
| selected | array of strings, required | A list of selected audience categories based on the suggestions generated. |
Example API Request
//https://api-eu.writetext.ai/text/Suggestion/Audience
Response
200
400
404
500
//The selected audience categories are successfully updated for the given product or category.
//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.