DUduda
Membership Configuration API

Update membership configuration

Updates the design-time (editor) membership configuration for the site: access mode, site-level protection and per-resource protection rules (the rules are applied as a patch). Changes affect the editor draft only; the published live site is not updated until publish. Protected resources must reference pages that exist in the site.

put/api/sites/multiscreen/{site_name}/membership/configuration

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/membership/configuration
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

Request body

membership_restriction_type'SELECTED_PAGES' | 'ALL_PAGES' required

ALL_PAGES: entire site is members-only. SELECTED_PAGES: only resources listed in resources_protection_rules are protected.

Example request

{
  "members_access": {
    "access_type": "AUTO_APPROVE"
  },
  "membership_restriction_type": "SELECTED_PAGES",
  "resources_protection_rules": [
    {
      "id": "7b31a091a92049bba02315a3c718ecb1",
      "protection_type": "MEMBERS_ONLY",
      "type": "PAGE"
    }
  ]
}

Response

OK

membership_restriction_type'SELECTED_PAGES' | 'ALL_PAGES'

ALL_PAGES: entire site is members-only. SELECTED_PAGES: only resources listed in resources_protection_rules are protected.

Example response

{
  "members_access": {
    "access_type": "AUTO_APPROVE"
  },
  "membership_restriction_type": "SELECTED_PAGES",
  "resources_protection_rules": [
    {
      "id": "7b31a091a92049bba02315a3c718ecb1",
      "protection_type": "MEMBERS_ONLY",
      "type": "PAGE"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.