PUT api/v1/addressbook/groups/{groupID}/contacts

This method adds a contact to selected group. The system will check that the user adding a contact is allowed. If the contact is already in the group, this method does nothing.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupID

globally unique identifier

Required

Body Parameters

Either xml or json request.

GroupContact
NameDescriptionTypeAdditional information
GroupID

The unique Id of the group

string

Required

ContactID

Array of contacts IDs.

Collection of string

Required

Request Formats

application/json, text/json

Sample:
{
  "GroupID": "sample string 1",
  "ContactID": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<GroupContact xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GroupID>sample string 1</GroupID>
  <ContactID>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ContactID>
</GroupContact>

Response Information

Resource Description

Status message of the request.

ResponseOfObject
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfObject

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {}
  }
}

application/xml, text/xml

Sample:
<ResponseOfObject xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail />
  </ResponseData>
</ResponseOfObject>