Updates structured elements in an AISearch project. Supported element types include miniapps (miniapp) and products (product).
Try it now
Test
RAM authorization
Request syntax
POST /api/v1/aiSearch/resource/update HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
Request parameters |
|
| type |
string |
Yes |
The type of the structured element. Valid values:
|
miniapp |
| resourceId |
string |
Yes |
The resource ID of the structured element. This ID is a unique and immutable identifier for the resource in the database. |
WzMGQZwB7nQEs3Qk3ajH |
| data |
any |
No |
Updates the information for the specified resource. Pass the fields to update in this parameter in JSON format. Fields that are not included are not modified. |
{ "title": "update title" } |
The type field is an enumeration that supports only the specified values. If you specify a value outside the allowed range, the API call fails. Additional structured content types will be added as needed.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
FDE51A3B-09C0-57E5-96FC-31E85EEFF318 |
| data |
object |
The data returned. |
|
| type |
string |
The type of the structured element. Valid values:
|
miniapp |
| resourceId |
string |
The resource ID of the structured element. This ID is a unique and immutable identifier for the resource in the database. |
WzMGQZwB7nQEs3Qk3ajH |
Examples
Success response
JSON format
{
"requestId": "FDE51A3B-09C0-57E5-96FC-31E85EEFF318",
"data": {
"type": "miniapp",
"resourceId": "WzMGQZwB7nQEs3Qk3ajH"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.