- 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
- 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
Add keyword for optimization pipelines
put
/text/Keywords/Optimization/Keywords
This endpoint adds a keyword so that it can be used in a pipeline.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Content-Type: application/json
Content-Type: application/json
Parameter Name | Type | Description |
---|---|---|
storeId | string, required | The store identifier. Defaults to "default" if not provided. |
type | string, required | Specifies the type of entity, which can be either Product or Category. |
recordId | string, required | The ID of the record for which the keyword is updated. |
languageCode | string | The language code. |
keyword | string, required | The keyword to be updated with optimization data. |
Example API Request
//https://api-eu.writetext.ai/text/Keywords/Optimization/Keywords
Response
200
400
404
500
//The request was successful, and the keyword optimization data was updated.
//This error occurs when the request is improperly formatted or lacks required parameters.
//This error occurs if the provided recordId, storeId, or keyword does not exist or cannot be found.
//The server encountered an error when processing the request.