- 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
Update alt text for an image
post
/text/Image/altText
This endpoint updates the alt text for a specific image. It allows you to modify the alt text content, set its status (publish/review), and apply the updates to the image.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Parameter Name | Type | Description |
---|---|---|
storeId | string, required | The storefront location identifier for the image. This helps differentiate images between different stores. |
language | string, required | The language code for the alt text. |
imageId | string, required | The unique identifier of the image for which the alt text needs to be updated. |
textId | string, required | The identifier of the current alt text that is being updated. |
value | string, required | The updated value of the alt text. |
publish | boolean, optional | Marks the alt text as published when set to true. |
reviewed | boolean, optional | Marks the alt text as reviewed when set to true. |
Example API Request
Response
200
400
404
500
//The alt text is successfully updated for the image, and the changes are reflected.
//The request is invalid due to malformed input.
//The specified image or alt text identifier could not be found.