Email Groups

This page lists the optional parameters, request data and reponse in xml

Retrieve group information [HTTP GET]

https://appapi.dlangemobile.com/xml/emailgroups/{api_key}/{group_id}

URL Parameters

• api_key (Required) - Your API application key.
• group_id (Required) - ID of group to retrieve data.

Response Notes

• ID - Used to update, delete and get group contacts

Example XML Response

<Group>
  <ID>1</ID>
  <Name>Group name</Name>
  <ColorCode>-13434625</ColorCode>
  <ContactsCount>2</ContactsCount>
</Group>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 201 - Define a valid Group ID.
• 202 - Invalid Group ID format. Group ID should be an integer.
• 203 - Group not found. Please provide a valid Group ID.

Update group information [HTTP PUT]

https://appapi.dlangemobile.com/xml/emailgroups/{api_key}/{group_id}

URL Parameters

• api_key (Required) - Your API application key.
• group_id (Required) - ID of group to retrieve data.

Request Notes

• ColorCode - color value in 32-bit ARGB format.

Example XML Request

<Group>
  <Name>Group name</Name>
  <ColorCode>-13434625</ColorCode>
</Group>

Response Notes

Returns the updated group if successful.

Example XML Response

<Group>
  <ID>1</ID>
  <Name>Group name</Name>
  <ColorCode>-13434625</ColorCode>
</Group>

Error Codes

• 001 - API key is required.
• 201 - Define a valid Group ID.
• 202 - Invalid Group ID format. Group ID should be an integer.
• 203 - Group not found. Please provide a valid Group ID.
• 208 - Provide a valid group info. Request XML is invalid or not passed as post data.
• 204 - Provide a group name.
• 205 - Group name should contain a maximum of 20 characters.
• 206 - Invalid color code format. It must be a 32-bit ARGB value.
• 207 - Group name already exists.

Delete group [HTTP DELETE]

https://appapi.dlangemobile.com/xml/emailgroups/{api_key}/{group_id}

URL Parameters

• api_key (Required) - Your API application key.
• group_id (Required) - ID of group to delete.

Response Notes

Returns status code 200 if successful. Otherwise returns error code.

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 201 - Define a valid Group ID.
• 202 - Invalid Group ID format. Group ID should be an integer.
• 203 - Group not found. Please provide a valid Group ID.