Page tree
Skip to end of metadata
Go to start of metadata

This method allows you to create a Group within a List.

Method Parameters

  • string CreateGroup(string accessKey, int listID, string groupName, stringgroupNotes)
    • accessKey: access key obtained using the LoginFromID method
    • listID: ID of the list that the new Group will belong to
    • groupName: name of the new Group
    • groupNotes: administrative notes for this new Group

 

If a group with the same name already exists in the list, then no new group is created and the ID of existing group is returned.

 

SOAP Examples


SOAP request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://services.mailupnet.it/WS">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:CreateGroup>
         <ws:accessKey>HzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9</ws:accessKey>
         <ws:listID>2</ws:listID>
         <ws:groupName>Top customers</ws:groupName>
         <ws:groupNotes>use notes for group description</ws:groupNotes>
      </ws:CreateGroup>
   </soapenv:Body>
</soapenv:Envelope> 


SOAP Response
<CreateGroupsResult>
  <errorCode>0</errorCode>
  <errorDescription></errorDescription>
  <list>
    <listID>2</listID>
    <listName>Demo</listName>
    <groups>
      <group>
        <groupID>1</groupID>
        <groupName>Top customers</groupName>
        <groupNotes>use notes for group description</groupNotes>
      </group>
    </groups>
  </list>
</CreateGroupsResult>



  • No labels

2 Comments

  1. Anonymous

    <groupdNotes>use notes for group description</groupNotes>

    should be:

    <groupNotes>use notes for group description</groupNotes>

  2. Thank you! We updated the page.