- 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
Lock a specific pipeline
post
/text/Keywords/Optimization/Pipelines/{id}/Lock
This API endpoint locks a specific pipeline identified by its ID. Locking a pipeline prevents further modifications, ensuring its integrity.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Content-Type: application/json
Content-Type: application/json
| Parameter Name | Type | Description |
|---|---|---|
| Id | string, required | Unique identifier for the pipeline to lock. |
| Parameter Name | Type | Description |
|---|---|---|
| storeId | string, required | Store ID identifying the pipeline's context. |
| type | string, required | Specifies the type of pipeline, which can be either Product or Category. |
| recordId | string, required | The Object ID associated with the pipeline. |
| languageCode | string, required | Two-letter language code, e.g., en. Default is en. |
Request body parameters
Response
200
400
404
500
//The request was successful, and the specified pipeline is now locked.
//The request failed due to invalid input or missing required parameters.
//The specified pipeline or related resource could not be found.
//The server encountered an error when processing the request.