HomeGuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Updates user groups by name

One or more users can be added by using "user_additions" instead of "users". One or more users can be deleted by using "user_deletions" instead of "users".

Sample Request Bodies

This endpoint supports additional XML request bodies that act similar to the HTTP PATCH method, allowing for the addition and deletion of individual users from an existing static group.

<user_group>
	<name>Teachers</name>
	<is_smart>true</is_smart>
	<is_notify_on_change>true</is_notify_on_change>
	<site>
		<id>-1</id>
		<name>None</name>
	</site>
	<criteria>
		<criterion>
			<name>Email Address</name>
			<priority>0</priority>
			<and_or>and</and_or>
			<search_type>like</search_type>
			<value>company.com</value>
			<opening_paren>false</opening_paren>
			<closing_paren>false</closing_paren>
		</criterion>
	</criteria>
</user_group>
<user_group>
    <name>Static Group</name>
    <is_smart>false</is_smart>
    <is_notify_on_change>false</is_notify_on_change>
    <site>
        <id>-1</id>
        <name>None</name>
    </site>
    <users>
        <user>
            <id>1938</id>
            <username>Mercy</username>
            <full_name/>
            <phone_number/>
            <email_address>[email protected]</email_address>
        </user>
        <user>
            <id>1939</id>
            <username>Aaron</username>
            <full_name/>
            <phone_number/>
            <email_address>[email protected]</email_address>
        </user>
    </users>
</user_group>
<user_group>
    <user_additions>
        <user>
            <id>1938</id>
        </user>
        <user>
            <id>1939</id>
        </user>
    </user_additions>
</user_group>
<user_group>
    <user_deletions>
        <user>
            <id>1938</id>
        </user>
        <user>
            <id>1939</id>
        </user>
    </user_deletions>
</user_group>
Language
Credentials
Basic
base64
: