Create new Group

post

https://api.gaggle.email/api/v3/group

Create a new Group and configure it as specified in the Group object. See Group API Eligibility.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The new group to create

This represents an email group. It contains all the settings and configuration for the group. Once created, the email address of a group cannot change.

name

string

description

string

organizationId

string

The id of the group's parent organization

includeNameInSubject

boolean

Whether to show the group name in the subject of messages sent to the group

includeNameInFromAddress

boolean

Whether to show the sender's name in the from address of messages sent to the group

whoCanSendToTheGroup

string

enum

Who is allowed to send to the group. organization lets anyone in the group's organization send, and needs the group to be in an organization.

Allowed:

whoAreRepliesSentTo

string

enum

Where replies to group messages go to. sendersDiscretion sends them to the original sender, but lets someone writing from the Gaggle website send them to the group instead.

Allowed:

sendWelcomeMessageToNewMembers

boolean

Whether to send the welcome message to new members

echoMessageToSender

boolean

Whether a messages sent to the group are allow sent to it's sender

membersViewMessageArchive

boolean

Whether members are allow to access the message archive

membersViewMemberList

boolean

Whether members are allow to view the member list

membersCanUnsubscribe

boolean

Whether a member who unsubscribes is removed from the group. true (the default) removes them. false keeps them as a member but stops all of the group's mail to them, so only an administrator can remove them. Setting false needs the Premium plan, and the setting can't be changed while an integration syncs the group's membership. See https://help.gaggle.email/article/320-members-can-unsubscribe

useCustomDomain

boolean

Whether to use the custom domain for the group

customDomain

string

The custom domain configured for this group. This should be a valid email address.

useCustomFooter

boolean

Whether to use a custom footer for the group

customFooter

string

The custom footer for the group. See https://help.gaggle.email/article/243-custom-footer-overview

useCustomWelcomeMessage

boolean

Whether to use a custom welcome message for the group

welcomeMessageSubject

string

The custom welcome message subject for the group.

welcomeMessageBody

string

The custom welcome message body for the group. See https://help.gaggle.email/article/255-how-customise-welcome-messages

useCustomMemberInviteMessage

boolean

Whether to use a custom member invite message for the group

customInviteMessageSubject

string

The custom member invite subject for the group.

customInviteMessageBody

string

The custom member invite message body for the group. See https://help.gaggle.email/article/255-how-customise-welcome-invite-messages

enableModeration

boolean

Whether to enable group message moderation

moderationMode

string

Either "include" or "exclude" to indicate whether moderation works on an inclusion or exclusion basis. See https://help.gaggle.email/article/228-moderating-members-how-choose

onlineSignup

boolean

Whether to allow online signup

allowAnyoneToSignup

boolean

Allow anyone to signup to the group

allowAnyoneToSignupApprovalRequired

boolean

Allow anyone to signup to the group but require approval from a group administrator

allowAnyoneInOrganizationToSignup

boolean

Allow anyone in the organization to signup to the group

allowAnyoneInOrganizationToSignupApprovalRequired

boolean

Allow anyone in the organization to signup to the group but require approval from a group administrator

incognitoMode

boolean

Whether incognito mode is enabled

Responses

400

Invalid email supplied

401

You don't have access to the group

403

membersCanUnsubscribe can't be set to false without the Premium plan, or changed while an integration syncs the group's membership

405

Validation exception

200Successful operation