POST api/Data/EditCustomGroup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PartnerKey	string	None.
CustomerId	integer	None.
apiKey	string	None.
GroupName	string	None.
Members	Collection of ApiCustomGroupEditMember	None.

Request Formats

application/json, text/json

Sample:

{
  "PartnerKey": "sample string 1",
  "CustomerId": 2,
  "apiKey": "sample string 3",
  "GroupName": "sample string 4",
  "Members": [
    {
      "ContactId": 1,
      "ExternalId": "sample string 2"
    },
    {
      "ContactId": 1,
      "ExternalId": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiCustomGroupEditRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models">
  <CustomerId>2</CustomerId>
  <GroupName>sample string 4</GroupName>
  <Members>
    <ApiCustomGroupEditMember>
      <ContactId>1</ContactId>
      <ExternalId>sample string 2</ExternalId>
    </ApiCustomGroupEditMember>
    <ApiCustomGroupEditMember>
      <ContactId>1</ContactId>
      <ExternalId>sample string 2</ExternalId>
    </ApiCustomGroupEditMember>
  </Members>
  <PartnerKey>sample string 1</PartnerKey>
  <apiKey>sample string 3</apiKey>
</ApiCustomGroupEditRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiGroupsResponse

Name	Type	Additional information
CustomerId	integer	None.
errorMsg	string	None.
Groups	Collection of ApiGroup	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "errorMsg": "sample string 2",
  "Groups": [
    {
      "GroupId": 1,
      "GroupType": "sample string 2",
      "GroupName": "sample string 3",
      "GroupExternalId": "sample string 4",
      "MemberIds": "sample string 5",
      "ContactIds": "sample string 6",
      "attributes": "sample string 7"
    },
    {
      "GroupId": 1,
      "GroupType": "sample string 2",
      "GroupName": "sample string 3",
      "GroupExternalId": "sample string 4",
      "MemberIds": "sample string 5",
      "ContactIds": "sample string 6",
      "attributes": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models">
  <CustomerId>1</CustomerId>
  <Groups>
    <ApiGroup>
      <ContactIds>sample string 6</ContactIds>
      <GroupExternalId>sample string 4</GroupExternalId>
      <GroupId>1</GroupId>
      <GroupName>sample string 3</GroupName>
      <GroupType>sample string 2</GroupType>
      <MemberIds>sample string 5</MemberIds>
      <attributes>sample string 7</attributes>
    </ApiGroup>
    <ApiGroup>
      <ContactIds>sample string 6</ContactIds>
      <GroupExternalId>sample string 4</GroupExternalId>
      <GroupId>1</GroupId>
      <GroupName>sample string 3</GroupName>
      <GroupType>sample string 2</GroupType>
      <MemberIds>sample string 5</MemberIds>
      <attributes>sample string 7</attributes>
    </ApiGroup>
  </Groups>
  <errorMsg>sample string 2</errorMsg>
</ApiGroupsResponse>