Skip to main content

Portal Pages & Blocks

Customize developer portal content with custom pages and reusable content blocks.

Portal Pages​

List pages​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/pages" \
  -H "Authorization: Bearer <your-token>"

Create a page​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/pages" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "faq",
    "displayName": "FAQ",
    "content": "# Frequently Asked Questions\n\n..."
  }'

Get a page​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/pages/<page-id>" \
  -H "Authorization: Bearer <your-token>"

Update a page​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/pages/<page-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "faq",
    "displayName": "FAQ (Updated)",
    "content": "# FAQ\n\nUpdated content..."
  }'

Delete a page​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/pages/<page-id>" \
  -H "Authorization: Bearer <your-token>"

Portal Content Blocks​

Content blocks are reusable components that can be placed on portal pages.

List blocks​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/blocks" \
  -H "Authorization: Bearer <your-token>"

Create a block​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/blocks" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "support-banner",
    "content": "<div class=\"banner\">Need help? Contact support@example.com</div>"
  }'

Update a block​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/blocks/<block-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "support-banner",
    "content": "<div class=\"banner\">Updated support info</div>"
  }'

Delete a block​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/blocks/<block-id>" \
  -H "Authorization: Bearer <your-token>"

Customize the portal navigation.

List menu items​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/menuItems" \
  -H "Authorization: Bearer <your-token>"

Update menu items​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/devPortals/<portal-id>/menuItems" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {"label": "Home", "url": "/"},
      {"label": "APIs", "url": "/apis"},
      {"label": "FAQ", "url": "/pages/faq"}
    ]
  }'