Skip to main content
POST
/
admin
/
views
/
{entity}
/
configurations
/
active
cURL
curl -X POST '{backend_url}/admin/views/{entity}/configurations/active' \
-H 'Authorization: Bearer {jwt_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
  "view_configuration_id": "{value}"
}'
{
"success": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity
string
required

The entity to update its view configuration (for example, orders).

Body

application/json

The details of a view configuration to set as active for the given entity.

view_configuration_id
string
required

The ID of the view configuration to set as active. If null, the active view configuration will be cleared, and the code or system default view configuration will be used as the active view.

Response

OK

The details of the operation.

success
boolean
required

Whether the operation was successful.