Updates the contact group by its id.
Name | Description | Type | Additional information |
---|---|---|---|
GroupId
The id of the contact group you would like to update.
Type
integer
Additional info
Required
|
|||
GroupId |
The id of the contact group you would like to update. |
integer |
Required |
A contact group object containing the new name. You can also specify the contact folder id to move contact group to a different contacts folder.
Name | Description | Type | Additional information |
---|---|---|---|
Name
The name of the contact group.
Type
string
Additional info
Required, Max length: 100
|
|||
Name |
The name of the contact group. |
string |
Required, Max length: 100 |
Description
A custom description which can be used to more clearly indicate the purpose of the group.
Type
string
Additional info
Max length: 130
|
|||
Description |
A custom description which can be used to more clearly indicate the purpose of the group. |
string |
Max length: 130 |
GroupFolderId
The id of the contacts folder in which you would like to create the group.
Type
integer
Additional info
Range: inclusive between 0 and 32767
|
|||
GroupFolderId |
The id of the contacts folder in which you would like to create the group. |
integer |
Range: inclusive between 0 and 32767 |
{ "Name": "sample string 1", "Description": "sample string 2", "GroupFolderId": 1 }
<SimpleGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Description>sample string 2</Description> <GroupFolderId>1</GroupFolderId> <Name>sample string 1</Name> </SimpleGroup>
Payload containing a boolean indicating if the update was successfull.
Name | Description | Type | Additional information |
---|---|---|---|
Meta
The metadata such as paging parameters, status code, timestamp,... which are related to this request.
Type
MetaData
|
|||
Meta |
The metadata such as paging parameters, status code, timestamp,... which are related to this request. |
MetaData | |
Data
The actual data returned by the request.
Type
boolean
|
|||
Data |
The actual data returned by the request. |
boolean | |
Links |
HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic. |
Hateoas |
{ "Meta": { "Status": 1, "TotalRowCount": 1, "Limit": 1, "Offset": 1, "TotalPageCount": 1, "StartRec": 1, "StopRec": 1, "Timestamp": "2024-09-07T23:55:22.9613753Z", "IsFiltered": true }, "Data": true }
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Data>true</Data> <Meta> <IsFiltered>true</IsFiltered> <Limit>1</Limit> <Offset>1</Offset> <StartRec>1</StartRec> <Status>1</Status> <StopRec>1</StopRec> <Timestamp>2024-09-08T00:55:22.9613753+01:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>