Group email

The group's webmaster email address. Used for the email generation and the contact us link

Method: get

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/group-theme/list/{groupId}

Parameters

property	value	description
groupId	guid	The group id which email you need to get.

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": "groupEmail",
    "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/"
    },
    "email": "joe@joe.com",
    "name": "Joe",
    "newsletterName": "Joe",
    "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
email	string	the email address of the group
name	string	The name field of the generated emails
newsletterName	string	The name field of the generated newsletter

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/group-email/{groupId}

Parameters

property	value	description
groupId	guid	The group id which email you need to get.

Request body

property	value	description
email	string	the group's email
name	string	the name field of the generated emails
newsletterName	string	the name field of the generated newsletters

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": "name",
      "value": "",
      "message": "Name cannot be blank"
    }
  ],
  "object": {
    "type": "groupEmail",
    "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/"
    },
    "email": "joe@joe.com",
    "name": "Joe",
    "newsletterName": "Joe",
    "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.