Sign in
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"
}

Changes

Changed in 3 of the 52 revisions of this API.15

  • b00b1727b8631See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 19e869275e2813See the full diff
    • ●

      added the new type enum value to the /////// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 96118a9cd7f41See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog