v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-263064641.4 MB

Portal Custom Domains

Enable or Disable Domain

Updates the portal domain associated with the portal.

patch/v3/portals/{portalId}/custom-domain

Request body

enabledboolean nullable

Response

Portal custom domain

hostnamestring required

enabledboolean required

cname_status'verified' | 'pending' required

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "ssl": {
    "uploaded_at": "2022-11-04T20:10:06.927Z",
    "expires_at": "2022-11-04T20:10:06.927Z"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}