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. On/off settings take true or false. Any

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 group's name in the from address of messages sent to the group, as "Sender via Group"

includeSenderNameInFromAddress

boolean

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

subAddressing

boolean

Whether the from address of messages sent to the group carries the sender's email address, using sub-addressing ([email protected], or the group's custom domain in place of gaggle.email), so members' email clients can tell senders apart. In incognito mode it carries an alias instead of the sender's address. Applies to members who also have sub-addressing on, which is their default. See https://help.gaggle.email/article/236-sub-addressing-how-it-works

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

preventDuplicateMessages

boolean

Whether a member who would get the same message through more than one group, such as one message sent to several groups they belong to, is sent it only once. See https://help.gaggle.email/article/208-how-prevent-duplicate-messages

membersViewMessageArchive

boolean

Whether members are allowed to access the message archive. Always false in incognito mode.

membersViewMemberList

boolean

Whether members are allowed to view the member list. Always false in incognito mode.

membersCanChangeEmail

boolean

Whether members can change their own email address. See https://help.gaggle.email/article/223-member-email-address-changes

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 address for this group, such as [email protected], or "" for none. It's stored in lowercase. An address on a domain an Organization hosts can only be used by a group in that Organization (which can be the one organizationId puts it in, in the same request).

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

moderationNotifySender

boolean

Whether the sender of a message is told when it is held for moderation

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. Turning it on sets membersViewMessageArchive and membersViewMemberList to false, and they stay false while it's on.

openRateTracking

boolean

Whether to track how many members open each message. Turning it on needs the Premium plan. See https://help.gaggle.email/article/306-open-rate-tracking

aiFeatures

boolean

Whether AI features, such as message summaries, are on. See https://help.gaggle.email/article/218-message-summaries

Responses

400

Invalid email supplied, or a setting that can't be used: an on/off setting that isn't true or false, a text setting that isn't a string, or a customDomain that isn't an email address or is on a domain an Organization hosts that the group isn't in. Nothing is changed.

401

You don't have access to the group

403

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

405

Validation exception

200Successful operation