1. v3
  2. ContactGroups
  3. POST - 3/contactgroups

Definition

POST - 3/ContactGroups

Create a new contactgroup.

Required roles: Contacts (write)

Request information

The new contact group containing a name, a description and optionally the contact folder id in which you would like to place the new contact group.

Name

The name of the contact group.


Type string
Additional info
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
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

Sample: 
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "GroupFolderId": 1
}
Sample: 
<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>

Response information

Payload containing the id of the new contact group.


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type integer
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.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-11-21T11:06:43.7262628Z",
    "IsFiltered": true
  },
  "Data": 1
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>1</Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-21T11:06:43.7262628+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>