Add Group

Audience: Low-code Engineers, System/Security Administrators

Skill Prerequisites: Actions, Tokens, Connectors

Creates a new connector group and saves its ID in a token.

Every connector belongs to a group, and every group holds connectors of a single type, for example IMAP. Some features can use a whole group at once. For example, an IMAP trigger in an Automation job can listen with every connector in a group. Create the group with this action, then add connectors to it with an action such as Add Imap Connector.

note

This action requires the Advanced Security feature (Enterprise) to be licensed.

Typical Use Cases

• Create a group for a new customer or department, then add its mailbox connectors to it
• Set up connector groups as part of an installation or onboarding process

Don't use it to

• Check whether a group exists. Use Find Group instead.
• Add a connector. Use Add Connector or a type-specific action such as Add Imap Connector.

Related Actions

Action Name	Description
Find Group	Finds a group by type and title and returns its ID.
Add Connector	Adds a connector of any type.
Add Imap Connector	Adds an IMAP connector to a group.
Add POP3 Connector	Adds a POP3 connector to a group.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Connector Type	The type of connectors the group will hold. Pick it from the list. In expression mode, the value must be the type name, for example ss.trigger.imap for IMAP or ss.trigger.pop3 for POP3.	Yes	empty string	Yes
Group title	The name of the new group, for example Support Mailboxes.	Yes	empty string	Yes
GroupId Token Name	The name of the token that gets the new group's ID, for example ImapGroupId.	No	empty string	No

Output Parameters Reference

Parameter	Description
GroupId Token Name	The ID of the new group, a number. Use it in the Group Title parameter of Add Imap Connector or Add POP3 Connector.

Considerations

• Group titles are unique per type. If a group of the same type already has this title, the action fails with A group of the provided connector type, with the same name, already exists. The check ignores case. Run Find Group first, and only add the group if it isn't found.
• An unknown type fails. If the connector type can't be found, the action fails with Could not find the credential type with the provided name.
• An empty title fails. Group title must have a value after tokens are replaced.
• Groups aren't tied to a portal. A group is available to every portal on the installation.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Create an IMAP group for a customer

This action creates an IMAP group named after the CustomerName token, for example Contoso Mailboxes, and saves its ID in [ImapGroupId].

{
    "Title": "Add Group",
    "ActionType": "CredStore.AddGroup",
    "Description": "Create the customer's IMAP group",
    "Parameters": {
        "Type": "ss.trigger.imap",
        "GroupName": "[CustomerName] Mailboxes",
        "GroupIdTokenName": "ImapGroupId"
    }
}

Revised 09/26/2026