Newsletter

When HiveSocial generates a newsletter, the group administrators have the ability to append a disclaimer text at the end of it. This functionality is provided by this method

Method: get

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/newsletter/settings/{groupId}

Parameters

property	value	description
groupId	guid	The id for which you need the newsletter settings 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": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "type": "groupNewsletterSettings",
    "group": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "disclaimer": "newsletter content",
    "accessWarnings": []
  }
}

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

property	value	description
group	object	The group for which you need the newsletter settings for.
disclaimer	string	The text that will be appended at the end of all generated emails

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/newsletter/settings/{groupId}

Parameters

property	value	description
groupId	guid	The id of the group for which you need to update the newsletter settings

Request body

property	value	description
disclaimer	string	The text that will be appended at the end of all generated emails

Response

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

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": false,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "disclaimer",
      "value": "",
      "message": "Some error"
    }
  ],
  "object": {
    "type": "groupNewsletterSettings",
    "group": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "disclaimer": "newsletter content",
    "accessWarnings": []
  }
}

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

property	value	description
success	Boolean	Whether the requested operation is successful or not
message	String	Human readable error information
errors	List (object)	List of validation errors, if any. The "key" property value is matched to one of the record's fields
object	object	The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.