Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_CreateGroup to create a new group. The group will be created with the caller as the group owner and the caller will also be the first user in the group.
The call needs an account id which will be the associated account for the group, unless the call is made to a realm with only one account. If the realm only has one account, then the account associated with the realm will be the group account.
If a realm has more than one account, the accountID parameter will be used to disambiguate the associated account for the group.
Permissions
The caller (user) must be the manager of the account where the group is created.
Request parameters
|
Parameter |
Value |
Required? |
|---|---|---|
|
name |
The name of the new group. It may not contain spaces or punctuation. |
yes |
|
description |
A text description of the group. |
yes |
|
accountId |
Optional. The account that will own the group. |
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_CreateGroup. |
|
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. |
|
group |
The XML structure of the group. |
Sample XML Request
POST https://target_domain/db/main HTTP/1.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_CreateGroup
<qdbapi>
<udata>misc data</udata>
<name>MarketingSupport</name>
<description>Support staff for sr marketing group</description>
<accountID>456789</accountID>
<ticket>auth_ticket</ticket>
</qdbapi>
Sample XML Get Request
https://target_domain/db/main?a=API_CreateGroup&accountID=212968
&name=MarketingSupport&description=Support%20staff%20for%20sr%20marketing%20group
<qdbapi>
<action>API_CreateGroup</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<group id="1217.dgpt">
<name>MarketingSupport</name>
<description>Support staff for sr marketing group</description>
<managedByUser>true</managedByUser>
</group>
</qdbapi>