User groups
URL
Request
Path parameters
Parameter name | Parameter type | Description |
user_group_id | string | Id of the user group |
Response
Returns an instance of UserGroupResource
URL
Request
Path parameters
Parameter name | Parameter type | Description |
user_group_id | string | Id of the user group |
Request body
Property name | Property type | Description |
user_group_name | string | Name of the User Group |
emails | array | Array of user emails to be updated |
Example body
{
"user_group_name": "TestUserGroup",
"emails": ["[email protected]", "[email protected]"],
} |
|
Response
Returns an empty response on successful completion.
URL
Request
Path parameters
Parameter name | Parameter type | Description |
user_group_id | string | Id of the user group |
Response
Returns an empty response on successful deletion.
URL
Request
Path parameters
Parameter name | Parameter type | Description |
client_id | string | Id of the client |
Response
Returns an object with “user_groups” as key and the value as an array of instances of UserGroupResource
URL
Request
Path parameters
Parameter name | Parameter type | Description |
client_id | string | Id of the client |
Request body
Property name | Property type | Description |
user_group_name | string | Name of the User Group |
emails | array | Array of user emails to be updated |
Example body
{
"user_group_name": "TestUserGroup",
"emails": ["[email protected]", "[email protected]"],
} |
|
Response
Returns a json response with “user_group_id” as the key and the id of the newly created user group as the value.
Last modified 1yr ago