Set company URLs for external dashboard

Set company-specific URL overrides for an external dashboard. This replaces all existing company URL assignments with the provided list. All URLs must use HTTPS. Companies must exist and belong to your tenant.

PUT /api/public/v1/dashboards/external/{id}/company-urls

Set company URLs for external dashboard

cURL

curl --request PUT \
  --url https://app.msportal.ai/api/public/v1/dashboards/external/{id}/company-urls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyUrls": [
    {
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>"
    }
  ]
}
'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "url": "<string>",
    "iconUrl": "<string>",
    "displayOrder": 123,
    "isActive": true,
    "isDefault": true,
    "allowInIframe": true,
    "framePolicy": "<string>",
    "roleIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "roleNames": [
      "<string>"
    ],
    "companyUrls": [
      {
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyName": "<string>",
        "url": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id · string<uuid> · required

External dashboard ID

Body

application/json

companyUrls · object[] · required

Company URL assignments

Show child attributes

Response

200

application/json

Company URLs updated

data · object · required

Show child attributes