PUT api/v1/addressbook/groups/{groupID}

This method updates the group name of the group provided. The system will check that the new name does not already exist for the account.

Request Information

URI Parameters

Name	Description	Type	Additional information
groupID	The group to be modified	globally unique identifier	Required

Body Parameters

Either xml or json request.

Group

Name	Description	Type	Additional information
GroupName	The name of the group.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "GroupName": "sample string 1",
  "GroupID": "28ff5c72-25c6-4f95-8e57-d62041fa40e2"
}

application/xml, text/xml

Sample:

<Group xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GroupName>sample string 1</GroupName>
  <GroupID>28ff5c72-25c6-4f95-8e57-d62041fa40e2</GroupID>
</Group>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfGroup

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfGroup	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "GroupName": "sample string 1",
      "GroupID": "1b148256-1412-4cb4-8624-1d6d76a3a739"
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <GroupName>sample string 1</GroupName>
      <GroupID>1b148256-1412-4cb4-8624-1d6d76a3a739</GroupID>
    </Detail>
  </ResponseData>
</ResponseOfGroup>