MATTR Learn

Update a VICAL configuration

Update VICAL configuration

Update the VICAL configuration for the requested ecosystem

PUT/v1/ecosystems/{ecosystemId}/vicals/configuration

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

Request Body

vicalProviderstring

VICAL provider name.

autoPublish?object

Configuration for automatic scheduled publishing of VICALs.

curl -X PUT "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration" \
  -H "Content-Type: application/json" \
  -d '{
    "vicalProvider": "Mattr"
  }'

curl -X PUT "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration" \  -H "Content-Type: application/json" \  -d '{    "vicalProvider": "Mattr"  }'

{
  "vicalProvider": "Mattr",
  "autoPublish": {
    "enabled": true,
    "frequency": "Daily",
    "configuredAt": "2025-07-01T00:00:00.000Z"
  }
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve VICAL configurations

Retrieve VICAL configuration

Retrieve the VICAL configuration from the requested ecosystem

GET/v1/ecosystems/{ecosystemId}/vicals/configuration

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

ecosystemIdstring

The UUID of the ecosystem

Formatuuid

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration"

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration"

{
  "vicalProvider": "Mattr",
  "autoPublish": {
    "enabled": true,
    "frequency": "Daily",
    "configuredAt": "2025-07-01T00:00:00.000Z"
  }
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete VICAL configuration

Delete the VICAL configuration for the requested ecosystem

DELETE/v1/ecosystems/{ecosystemId}/vicals/configuration

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

curl -X DELETE "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration"

curl -X DELETE "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration"

Empty

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Configuration

On this page