Create a new group

Creates a new group. The group can be either created empty or contacts can be added to it during the creation. The contacts can be added by using filters.

BODY PARAMETERS

KEY

OPTIONAL

DESCRIPTION

name

No

The name of the group to be created.

strategy

Yes

Defines the way that the group should be populated. If not set (or set to 'None') the group will be empty. If it's set to 'Filtered' the group will be populated based on the filters provided. If it's set to 'All', the group will include all the contacts of the account.

filters

Yes

The filters to apply and create the group from their result.

filters.fieldName

Yes

Defines the name of the field for this filter.

filters.searchTerm

Yes

Defines the search term to be used for the search.

filters.searchOperator

Yes

Optional: The operator upon which the search operation will be executed. Possible values: 'is', 'is_not', 'contains', 'starts_with', 'ends_with'. If missing defaults to 'is'.

RESPONSE PARAMETERS

KEY

DESCRIPTION

name

The name of the group.

size

The size of the new group.

ERROR CODES

STATUS

CODE

DESCRIPTION

404

404001001

Account not found

409

409002005

The contact group already exists

400

400002007

Search filters are invalid

Language