siteId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
Update suggestion properties such as rank, data, and kpiDeltas.
+
Important: The status and type fields are READ-ONLY via this endpoint.
+
To update suggestion status, use the batch status endpoint:
+PATCH /sites/{siteId}/opportunities/{opportunityId}/suggestions/status
+
path Parameters siteId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
The site ID in uuid format
opportunityId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
The opportunity ID in uuid format
@@ -6054,8 +6062,30 @@
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci /sites/{siteId}/opportunities/{opportunityId}/suggestions/{suggestionId}/fixes
https://spacecat.experiencecloud.live/api/v1 /sites/{siteId}/opportunities/{opportunityId}/suggestions/{suggestionId}/fixes
Response samples Content type application/json
Copy
Expand all Collapse all { "data" :
[ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"opportunityId" : "3d9795f2-7722-4e1d-b41e-0c5d0c24a902" ,
"type" : "REDIRECT_UPDATE" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"executedBy" : "string" ,
"executedAt" : "2019-08-24T14:15:22Z" ,
"publishedAt" : "2019-08-24T14:15:22Z" ,
"changeDetails" : { } ,
"status" : "PENDING"
} ] } Update the status of one or multiple suggestions in one transaction
- path Parameters siteId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
https://spacecat.experiencecloud.live/api/v1 /sites/{siteId}/opportunities/{opportunityId}/suggestions/{suggestionId}/fixes
Response samples Content type application/json
Copy
Expand all Collapse all { "data" :
[ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"opportunityId" : "3d9795f2-7722-4e1d-b41e-0c5d0c24a902" ,
"type" : "REDIRECT_UPDATE" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"executedBy" : "string" ,
"executedAt" : "2019-08-24T14:15:22Z" ,
"publishedAt" : "2019-08-24T14:15:22Z" ,
"changeDetails" : { } ,
"status" : "PENDING"
} ] } Batch update suggestion status
+ Update the status of one or more suggestions in a single transaction.
+
This is the only endpoint that allows updating suggestion status.
+The individual suggestion PATCH endpoint (/suggestions/{suggestionId})
+does not support status updates.
+
Each request item must include:
+
+id: The UUID of the suggestion to update
+status: The new status value
+
+
Returns a 207 Multi-Status response with individual results for each suggestion,
+including success/failure status codes and any error messages.
+
path Parameters siteId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
The site ID in uuid format
opportunityId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
The opportunity ID in uuid format
@@ -6063,10 +6093,24 @@
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
UUID of this suggestion
status required
string (SuggestionStatus)
Enum: "NEW" "APPROVED" "SKIPPED" "FIXED" "ERROR" "IN_PROGRESS" "OUTDATED" "PENDING_VALIDATION"
Status of this suggestion; status reflects overall fix execution, flagged here for optimization
-
Responses 207 A list of suggestions updated,
-or the status code and error message for the ones failed.
+
Responses 207 Multi-Status - Batch operation completed with individual results.
+Each item in the response includes the suggestion UUID, index, status code,
+and either the updated suggestion data (on success) or an error message (on failure).
+
patch /sites/{siteId}/opportunities/{opportunityId}/suggestions/status https://spacecat.experiencecloud.live/api/ci /sites/{siteId}/opportunities/{opportunityId}/suggestions/status
Example for broken backlinks suggestions status update
Copy
Expand all Collapse all Response samples Content type application/json
Example for broken backlinks suggestions status update response
-
Copy
Expand all Collapse all { "suggestions" :
[ { "id" : "945e4567-f543-12d3-a456-426614174010" ,
"index" : 1 ,
"statusCode" : 400 ,
"message" : "Validation failed in suggestion: status must be one of NEW,APPROVED,SKIPPED,FIXED,ERROR"
} ] , "metadata" :
{ "total" : 2 ,
"success" : 1 ,
"failure" : 1
} } Trigger autofix for one or multiple suggestions, and set them to 'In Progress'
+Copy
Expand all Collapse all { "suggestions" :
[ { "uuid" : "945e4567-f543-12d3-a456-426614174010" ,
"index" : 1 ,
"statusCode" : 400 ,
"message" : "Validation failed in suggestion: status must be one of NEW,PENDING_VALIDATION,APPROVED,SKIPPED,FIXED,ERROR,IN_PROGRESS,OUTDATED"
} ] , "metadata" :
{ "total" : 2 ,
"success" : 1 ,
"failed" : 1
} } Trigger autofix for one or multiple suggestions, and set them to 'In Progress'
path Parameters siteId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
The site ID in uuid format
opportunityId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
https://spacecat.experiencecloud.live/api/v1 /sites/{siteId}/opportunities/{opportunityId}/suggestions/auto-fix
Request samples Content type application/json
Copy
Expand all Collapse all Response samples Content type application/json
Example for broken backlinks suggestions status update response
-
Copy
Expand all Collapse all { "suggestions" :
[ { "id" : "945e4567-f543-12d3-a456-426614174010" ,
"index" : 1 ,
"statusCode" : 400 ,
"message" : "Validation failed in suggestion: status must be one of NEW,APPROVED,SKIPPED,FIXED,ERROR"
} ] , "metadata" :
{ "total" : 2 ,
"success" : 1 ,
"failure" : 1
} } Retrieve key events for a site Copy
Expand all Collapse all { "suggestions" :
[ { "uuid" : "945e4567-f543-12d3-a456-426614174010" ,
"index" : 1 ,
"statusCode" : 400 ,
"message" : "Validation failed in suggestion: status must be one of NEW,PENDING_VALIDATION,APPROVED,SKIPPED,FIXED,ERROR,IN_PROGRESS,OUTDATED"
} ] , "metadata" :
{ "total" : 2 ,
"success" : 1 ,
"failed" : 1
} } Retrieve key events for a site This endpoint returns key events for a site chronologically, starting from the most recent and descending to the least recent
path Parameters siteId required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000
The site ID in uuid format
@@ -9296,7 +9340,7 @@
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Production server
https://spacecat.experiencecloud.live/api/v1 /sites/{siteId}/opportunities/{opportunityId}/status
Request samples Content type application/json
Copy
Expand all Collapse all Response samples Content type application/json
Copy
Expand all Collapse all { "fixes" :
[ { "index" : 0 ,
"statusCode" : 0 ,
"fix" :
{ "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"opportunityId" : "3d9795f2-7722-4e1d-b41e-0c5d0c24a902" ,
"type" : "REDIRECT_UPDATE" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"executedBy" : "string" ,
"executedAt" : "2019-08-24T14:15:22Z" ,
"publishedAt" : "2019-08-24T14:15:22Z" ,
"changeDetails" : { } ,
"status" : "PENDING"
} } ] , "metadata" :
{ "total" : 0 ,
"success" : 0 ,
"failure" : 0
} }