Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

UserGroup.Create

Description

Creates a new user group

Oempro Version

4+

Request Parameters

SessionID = {string} (required)

Session ID which is needed to authenticate the access. It's optional and required for desktop applications only

Command = {UserGroup.Create} (required)

API Command

ResponseFormat = {JSON | XML} (required)

Response format

JSONPCallBack = {bool}

Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP

GroupName = {string} (required)

Name of the group

RelThemeID = {integer} (required)

Theme ID for the group

SubscriberAreaLogoutURL = {string} (required)

URL where subscriber will be redirected after logout

ForceUnsubscriptionLink = {Enabled | Disabled} (required)

Whether force user to include unsubscription link inside emails or not

ForceRejectOptLink = {Enabled | Disabled} (required)

Whether force user to include reject link inside opt-in confirmation emails

Permissions = {string} (required)

Permission list separated by comma

PaymentSystem = {Enabled | Disabled} (required)

Payment system status

PaymentPricingRange = {string} (required)

Payment pricing for per recipient and per auto responder pricing models. Data must be provided in following format: until|price Example: 1000|0.00,5000|0.01,-1|0.07

PaymentCampaignsPerRecipient = {Enabled | Disabled} (required)

Whether to charge per campaign recipient or not

PaymentCampaignsPerCampaignCost = {double} (required)

Pricing per sent campaign

PaymentAutoRespondersChargeAmount = {double} (required)

Monthly auto responder pricing fee

PaymentAutoRespondersPerRecipient = {Enabled | Disabled} (required)

Whether to charge per sent auto responder or not

PaymentDesignPrevChargeAmount = {double} (required)

Monthly design preview pricing fee

PaymentDesignPrevChargePerReq = {double} (required)

Per design preview request fee

PaymentSystemChargeAmount = {double} (required)

Monthly system usage/subscription fee

LimitSubscribers = {integer} (required)

Maximum number of subscribers that user can store in the account

LimitLists = {integer} (required)

Maximum number of lists that user can store in the account

LimitCampaignSendPerPeriod = {integer} (required)

Maximum number of campaigns that user can send every month

LimitEmailSendPerPeriod = {integer} (required)

Maximum number of emails that user can send every month

ThresholdImport = {integer} (required, 4.0.5+)

The threshold value to trigger admin notification systems during the import

ThresholdEmailSend = {integer} (required, 4.0.5+)

The threshold value to trigger admin notification systems during the email delivery

PlainEmailHeader = {string} (optional, 4.1.0+)

The header content for text only email campaigns

PlainEmailFooter = {string} (optional, 4.1.0+)

The footer content for text only email campaigns

HTMLEmailHeader = {string} (optional, 4.1.0+)

The header content for HTML email campaigns

HTMLEmailFooter = {string} (optional, 4.1.0+)

The footer content for HTML email campaigns

TrialGroup = {Enabled | Disabled} (required, 4.1.0+)

Set the user group as trial or not

TrialExpireSeconds = {integer} (optional, 4.1.0+)

Number of seconds after the user sign-up to expire

SendMethod = {System | SMTP | LocalMTA | PHPMail | PowerMTA | SaveToDisk} (required, v4.1.0+)

Set a different sending method for the user group

SendMethodSaveToDiskDir = {string} (optional, 4.1.0+)

Path to save emails. It should be writable

SendMethodPowerMTAVMTA = {string} (optional, 4.1.0+)

Virtual MTA name to send emails from through PowerMTA

SendMethodPowerMTADir = {string} (optional, 4.1.0+)

PowerMTA pick-up directory. It should be writable

SendMethodLocalMTAPath = {string} (optional, 4.1.0+)

Path of your local MTA. It should be executable via PHP and web server user

SendMethodSMTPHost = {string} (optional, 4.1.0+)

Host or IP address of the SMTP server

SendMethodSMTPPort = {integer} (optional, 4.1.0+)

Port number (usually 25) of the SMTP server

SendMethodSMTPSecure = { ssl | tls | } (optional, 4.1.0+)

SMTP server security mode

SendMethodSMTPTimeOut = {integer} (optional, 4.1.0+)

Set the number of seconds to time-out during inactivity

SendMethodSMTPAuth = {true | false} (optional, 4.1.0+)

Set whether SMTP server requires authentication or not

SendMethodSMTPUsername = {string} (optional, 4.1.0+)

The username to login to the SMTP server

SendMethodSMTPPassword = {string} (optional, 4.1.0+)

The password to login to the SMTP server

Response Parameters

Success = {true | false}

States if there is an error or not

ErrorCode = {integer}

If there is an error, error's code

UserGroupID = {integer}

ID number of the new user group

Error Codes

1

Missing user group name

2

Missing subscriber area logout url

3

Missing user permissions

4

Missing payment system status

5

Missing subscriber limit

6

Missing list limit

7

Missing campaigns per period limit

8

Missing theme ID

9

Campaign per recipient pricing status is missing

10

Per campaign pricing status is missing

11

Auto responder periodical charge amount is missing

12

Per auto responder send pricing is missing

13

Design preview periodical charge amount is missing

14

Per design preview pricing is missing

15

Periodical system subscription pricing is missing

16

Pricing range is missing

17

force unsubscription link is missing

18

force opt-in confirm link is missing

19

Invalid theme ID

20

Missing email delivery per month limitation

21

The trial period is missing

22

Invalid send method

23

Invalid send method security type

24

Invalid SMTP auth type

25

Invalid send method. Testing failed.

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!