1. v3
  2. ContactGroups
  3. DELETE - 3/contactgroups/{groupid}/contacts/{contactid}

Definition

DELETE - 3/contactgroups/{GroupId}/contacts/{ContactId}

Remove a contact by id. 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

GroupId

The id of the contact group in which you would like to delete the contact.


Type integer
Additional info
Required
ContactId

The id of the contact to be deleted.


Type integer
Additional info
Required

Response information

Payload containing a boolean indicating if the requested contact was indeed removed.


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


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-03T18:00:37.3234749Z",
    "IsFiltered": true
  },
  "Data": true
}
Sample: 
<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-12-03T18:00:37.3234749+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>