VICALAPI Reference
Configuration
Update a VICAL configuration
PUT
/v1/ecosystems/{ecosystemId}/vicals/configurationAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidRequest Body
application/json
vicalProvider*string
VICAL provider name.
autoPublish?
Configuration for automatic scheduled publishing of VICALs.
Response Body
application/json
application/json
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
GET
/v1/ecosystems/{ecosystemId}/vicals/configurationAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/json
application/json
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
/v1/ecosystems/{ecosystemId}/vicals/configurationAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/json
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"
}
]
}How would you rate this page?