WriteText.ai API - Update keyword optimization pipelines

Requirements

Authentication Required

Bearer access_token

Request Headers

Authorization: Bearer access_token
Content-Type: application/json

Parameter Name	Type	Description
storeId	string, optional	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, optional	Two-letter language code, e.g., `en`. Default is `en`.
keywords	object, required	Keywords to include in the pipeline, with additional properties.
triggers	object, optional	Triggers to apply to keywords, with `option`, `value`, `action`, and `textTypes`.

Example API Request

                    {<br>  "storeId": "store123",<br>  "type": "Product",<br>  "recordId": "record456",<br>  "languageCode": "en",<br>  "keywords": {<br>    "additionalProp1": "keyword1",<br>    "additionalProp2": "keyword2"<br>  },<br>  "triggers": {<br>    "additionalProp1": {<br>      "option": "None",<br>      "value": 0,<br>      "action": "FlagForRewrite",<br>      "textTypes": ["string"]<br>    }<br>  }<br>}
                

Response

200

400

404

500

//The request was successful, and the keyword pipeline was updated.

<p>{<br>  "pipeline": {<br>    "id": "pipeline123",<br>    "name": "Optimization Pipeline",<br>    "date": "2025-01-24T07:57:20.039Z",<br>    "autogenerated": true,<br>    "locked": false,<br>    "keywords": {<br>      "additionalProp1": {<br>        "keyword": "exampleKeyword",<br>        "date": "2025-01-24T07:57:20.039Z",<br>        "position": 1,<br>        "positionDelta": 1,<br>        "searchVolume": 100,<br>        "difficulty": 10,<br>        "intent": "Informational",<br>        "trafficPotential": 500<br>      }<br>    },<br>    "currentLevel": "Basic",<br>    "currentState": "Active"<br>  },<br>  "availableClustersToRestore": 1<br>}</p>

//This error occurs when the request body is invalid.

<p>{<br>  "type": "ValidationError",<br>  "title": "Invalid request body",<br>  "status": 400,<br>  "detail": "Missing required field: storeId",<br>  "instance": "request-instance-123"<br>}</p>

//This error occurs when the pipeline or the associated resource (e.g., storeId or recordId) is not found.

<p>{<br>  "type": "ResourceNotFound",<br>  "title": "Pipeline not found",<br>  "status": 404,<br>  "detail": "The requested pipeline does not exist.",<br>  "instance": "request-instance-123"<br>}</p>

//The server encountered an error when processing the request.