API_RemoveUserFromGroup

Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.

Overview

Use API_RemoveUserFromGroup to remove a user from a group.

Request parameters

Parameter	Value	Required?
gid	The id of the group to manage.	yes
uid	The id of the user to be removed from the group.	yes
email	The email of the Quickbase user	no
screenName	The screen name of the Quickbase user, if set	no
ticket	A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call.	yes
udata	A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response.	no

Response values

Element Name	Value
action	The originating request, for example, API_RemoveUserFromGroup.
errcode	Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.) 0 indicates that no error was encountered.
errtext	Text that explains the error code. "No error" indicates that no error was encountered.
udata	Optional. Contains any udata value supplied in the request.

Sample XML Request

POST https://target_domain/db/main HTTP/1.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION:API_RemoveUserFromGroup

<qdbapi>
   <udata>misc data</udata>
   <ticket>auth_ticket</ticket>
   <gid>345889.sjkl</gid>
   <uid>9380434.rtgf</uid>
</qdbapi>

Sample HTTP Get Request

https://target_domain/db/main?a=API_RemoveUserFromGroup&gid=345889.sjkl 
&uid=9380434.rtgf&ticket=auth_ticket&udata=misc%20data

<?xml version="1.0" ?>
<qdbapi>
   <action>API_RemoveUserFromGroup</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <udata>misc data</udata>
</qdbapi>

What happens if you try to remove the only manager from a group?

When you run the API call to remove a group you're the manager for, it returns this message in the response:

{
"message": "Bad Request",
"description": "All group managers are marked for removal. At least one manager should be left in the group."
}