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

Definition

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

Add an existing contact to a contact group.

Required roles: Contacts (write)

Request information

GroupId

The id of the contact groups to the contact will be added.


Type integer
Additional info
Required
ContactId

The id of the contact to be added to the group.


Type integer
Additional info
Required

Response information

A boolean indicating if the request was successfull, we will return true in case the contact was added or was already in the list. We will return false in case we are unable to link a contact to a 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 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.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-22T03:13:17.2120529Z",
    "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>2024-12-22T03:13:17.2120529+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>