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

KEYOPTIONALDESCRIPTION
nameNoThe name of the group to be created.
strategyYesDefines 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.
filtersYesThe filters to apply and create the group from their result.
filters.fieldNameYesDefines the name of the field for this filter.
filters.searchTermYesDefines the search term to be used for the search.
filters.searchOperatorYesOptional: 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

KEYDESCRIPTION
nameThe name of the group.
sizeThe size of the new group.

ERROR CODES

STATUSCODEDESCRIPTION
404404001001Account not found
409409002005The contact group already exists
400400002007Search filters are invalid
Language