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.
GroupName | Description | Type | Additional information |
---|---|---|---|
GroupName |
The name of the group. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "GroupName": "sample string 1", "GroupID": "e4f64056-2614-46e9-a85e-983ce9c631cf" }
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>e4f64056-2614-46e9-a85e-983ce9c631cf</GroupID> </Group>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfGroupName | 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": "91a05cce-105b-4e09-b145-9851467c2182" } } }
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>91a05cce-105b-4e09-b145-9851467c2182</GroupID> </Detail> </ResponseData> </ResponseOfGroup>