Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Method parameters:

CreateGroup(int idList, int listGUID, string newGroupName) Crea un nuovo gruppo per la lista specificata.
Parametri

Creates a new group for the specified list.

  • idList:

...

  • list identifier
  • listGuid: GUID

...

  • -300 unrecognized error
  • -301 of the list
  • newGroupName: name of the group to be created

 

Info

The returned value is the ID of the created group.

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

Maximum allowed lenght for Group names is 50 characters, if you specify more than 50 characters the actual Group name will be truncated by MailUp



Sample CreateGroup response

Code Block
languagehtml/xml
linenumberstrue
<mailupMessage>
  <mailupBody>
    <ReturnCode>12</ReturnCode>
  </mailupBody>
</mailupMessage>

Error codes 

Error codeDescription
-300unrecognized error
-301the list has not been specified
-302the group name has not been specified
-303the group already exists

Ruby Example

Code Block
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::Import.new('username', 'password', 'console_url')
m.create_group(:idList => 123456, :listGuid => 'abc123', :newGroupName => 'Sample Group')
# => <?xml version=\"1.0\" encoding=\"windows-1252\" ?><mailupMessage><mailupBody><ReturnCode>12</ReturnCode></mailupBody></mailupMessage>