System page

Method: get home page

Authorization is required. Root group administrator's privileges are required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/system-page/home-page

Parameters

Do not supply a request parameters with this method.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Amet reprehenderit ad duis ad irure qui id ut minim minim culpa officia.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "type": "HomePage",
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: update home page

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/system-page/home-page

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
content string The home page's text or HTML content

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "content",
      "value": "",
      "message": "Error message"
    }
  ],
  "object": {
    "type": "HomePage",
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur. ",
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: get group private landing page

Authorization is required. Group administrator's privileges are required. The private landing page will be presented to a user visiting a private group, when he has no privileges to enter.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/system-page/private-landing-page/group/{groupId}

Parameters

propertyvaluedescription
groupId guid The ID of the group you need the private landing page for

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Amet reprehenderit ad duis ad irure qui id ut minim minim culpa officia.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "type": "PrivateLandingPage",
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: update private landing page

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/system-page/private-landing-page/group/{groupId}

Parameters

propertyvaluedescription
groupId guid The ID of the group you need to update the private landing page for

Request body

propertyvaluedescription
content string The private landing page's text or HTML content

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "content",
      "value": "",
      "message": "Error message"
    }
  ],
  "object": {
    "type": "PrivateLandingPage",
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: get group premium landing page

Authorization is required. Group administrator's privileges are required. The premium landing page will be presented to a user visiting a premium group, when he has no privileges to enter. If the premium landing page is disabled, the User will be able to enter the group, but he will see the content according to the group specific settings.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/system-page/premium-landing-page/group/{groupId}

Parameters

propertyvaluedescription
groupId guid The ID of the group you need the premium landing page for

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Amet reprehenderit ad duis ad irure qui id ut minim minim culpa officia.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "type": "PremiumLandingPage",
    "isEnabled": true,
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: update premium landing page

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/system-page/premium-landing-page/group/{groupId}

Parameters

propertyvaluedescription
groupId guid The ID of the group you need to update the premium landing page for

Request body

propertyvaluedescription
isEnabled boolean Is the premium page enabled
content string The premium landing page's text or HTML content

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "content",
      "value": "",
      "message": "Error message"
    }
  ],
  "object": {
    "type": "PremiumLandingPage",
    "isEnabled": false,
    "content": "Ipsum commodo deserunt nostrud culpa do eu duis velit adipisicing nostrud excepteur.",
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.