Definition

DELETE - 3/contactgroups/{GroupId}/contacts

Remove all contacts from this group. If the contact is only linked to the indicated group, the contact will be removed completely. If the contact is linked to other contact groups, the contact will be removed from this group but he/she will remain in other groups.

Required roles: Contacts (write)

Request information

NameDescriptionTypeAdditional information
GroupId

The group identifier.

integer

Required

Response information


NameDescriptionTypeAdditional information
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.

ManipulationResult

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

Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-01-17T16:08:33.4186945Z",
    "IsFiltered": true
  },
  "Data": {
    "Succeeded": true,
    "FailureMessage": "sample string 2"
  }
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <FailureMessage>sample string 2</FailureMessage>
    <Succeeded>true</Succeeded>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-01-17T16:08:33.4186945+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>