Start keyword optimization

put /text/Keywords/Optimization
This endpoint starts a new keyword optimization for a specific record in the store. The optimization process analyzes the text's performance, suggesting keywords, ranking them, and providing potential optimization steps for better performance.

Requirements

Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
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 to update.
languageCode string, optional A 2-letter code indicating the language, e.g., "en". Defaults to "en" if not provided.
ipAddress string, optional The IP address of the client making the request.
url string, optional A URL associated with the record.
name string, optional The name of the record.
imageId array, optional The ID of the associated image.
intents array, optional A list of intents associated with the record.
seedKeywords array, optional A list of seed keywords for optimization.
countryCode string, optional The country code associated with the operation.
clusters integer, optional The number of clusters for optimization.
triggers object, optional Triggers for specific actions, containing options, values, and actions.

Example API Request

//https://api-eu.writetext.ai/text/Keywords/Optimization

Response

200
400
404
500
//The keyword optimization data has been successfully updated.
//This error occurs when the request is invalid or contains missing/incorrect fields.
//The specified record or related resource (e.g., storeId, recordId, etc.) could not be found.
//The server encountered an error when processing the request.