Set suggestions configuration

POST /api/v1/suggestions/config

Sets the auto-suggestion priority order configuration. Only Standard Registry users are allowed to make this request.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Permissions.SUGGESTIONS_SUGGESTIONS_UPDATE


Request

Request Body

{
  "items": [
    {
      "blockType": "requestVcDocumentBlock",
      "order": 1
    },
    {
      "blockType": "sendToGuardianBlock",
      "order": 2
    }
  ]
}
Field
Type
Required
Description

items

array

Yes

List of suggestion priority configuration entries

items[].blockType

string

Yes

Block type for this priority entry

items[].order

number

Yes

Priority order (lower number = higher priority)


Response

Success Response

Status: 201 Created

Field
Type
Description

items

array

The saved suggestion priority configuration

items[].id

string

Unique identifier of the configuration entry

items[].blockType

string

Block type for this priority entry

items[].order

number

Priority order (lower number = higher priority)

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

500 Internal Server Error

Unexpected server failure

Last updated

Was this helpful?