You can update a smart group name and rules with the updateSmartGroup method.
Permissions to run the request: Account Owner, Administrators, Department Administrators or users with a role with custom settings allowing to edit smart groups.
|credentials (required)||credentials||Read the description of the Credentials object.|
|groupId (required)||string||The ID of a smart group you would like to edit.|
|name (optional)||string||The name of the smart group.|
A list of smart group rules.
Can have the following values:
|attributeId (optional)||string||The user field ID. Should be filled out only if attributeType is 3.|
For groups and user fields:
For user profile fields:
Note: for the Country field, use the country ID, not its name. The country ID can be obtained with the Getting User Profile Fields method.
You can add multiple groups of conditions that should be satisfied to add a user to a smart group. All groups of conditions should be met at the same time.
Inside these groups of conditions, add rules. Any of the rules can be completed so that a user was added to the smart group.
Read more about smart groups, their rules and conditions in the Creating Smart Groups article.
After the request has been successfully processed, the system returns an object with the following properties:
|success||bool||True if the smart group has been successfully updated.|
|Unknown Group||The smart group is not found.|
|Permission denied||The user has no permissions to update smart groups.|
|Wrong Parameters||The system failed to process the request because it did not contain all necessary parameters.|