SetImGroup operation
Published: July 16, 2012
Find information about the SetImGroup EWS operation.
Applies to: Exchange 2013 | Exchange Online
The SetImGroup operation changes the display name of an instant messaging (IM) group.
This operation was introduced in Exchange Server 2013.
The SetImGroup operation only takes a single display name argument.
SetImGroup operation SOAP headers
The SetImGroup operation can use the SOAP headers that are listed in the following table.
Header name | Element | Description |
|---|---|---|
Impersonation | Identifies the user whom the client application is impersonating. This header is applicable to a request. | |
MailboxCulture | Identifies the culture, as defined in RFC 3066, "Tags for the Identification of Languages", to be used to access the mailbox. This header is applicable to a request. | |
RequestVersion | Identifies the schema version for the operation request. This header is applicable to a request. | |
ServerVersion | Identifies the version of the server that responded to the request. This header is applicable to a response. |
The following example of a SetImGroup operation request shows how to change an IM group display name to "MyNewGroupName".
 Note |
|---|
The Exchange store identifier has been shortened to preserve readability. |
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
<t:MailboxCulture>en-US</t:MailboxCulture>
</soap:Header>
<soap:Body >
<m:SetImGroup>
<m:GroupId Id="AAMkAGQ1MjJjMTBkQoTbWAAAAAAQRAAA="
ChangeKey="EgAAAA=="/>
<m:NewDisplayName>MyNewGroupName</m:NewDisplayName>
</m:SetImGroup>
</soap:Body>
</soap:Envelope>
The request SOAP body contains the following elements:
The following example shows a successful response to a SetImGroup operation request.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="349"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SetImGroupResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
</SetImGroupResponse>
</s:Body>
</s:Envelope>
The response SOAP body contains the following elements:
The following example shows an error response to a SetImGroup operation request. The following error response occurs when an attempt is made to change the group display name to the existing group display name.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="349"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SetImGroupResponse ResponseClass="Error"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<MessageText>An IM group with the specified display name already exists.</MessageText>
<ResponseCode>ErrorImGroupDisplayNameAlreadyExists</ResponseCode>
<DescriptiveLinkKey>0</DescriptiveLinkKey>
</SetImGroupResponse>
</s:Body>
</s:Envelope>
The error response SOAP body contains the following elements:
For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.
Date | Description |
|---|---|
July 16, 2012 | Initial publication |
