Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_ChangeGroupInfo to modify the metadata for a group. One or more elements can be modified.
Request parameters
Parameter | Value | Required? |
|---|---|---|
gid | The id of the group to manage. | yes |
name | The name of the new group. It may not contain spaces or punctuation. | no |
description | A text description of the group. | no |
accountId | 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_ChangeGroupInfo. |
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_ChangeGroupInfo
<qdbapi>
<udata>misc data</udata>
<ticket>auth_ticket</ticket>
<gid>345889.sdjl</gid>
<name>AcmeSalesTeamLeads</name>
<description>Team Leaders for the Acme division</description>
</qdbapi>
Sample HTTP Get Request
https://target_domain/db/main?a=API_ChangeGroupInfo&gid=345889.sdjl
&name=AcmeSalesTeamLeads&Team%20Leaders%20for%20the%20Acme%20division&
ticket=auth_ticket&udata=misc%20data
<?xml version="1.0" ?>
<qdbapi>
<action>API_ChangeGroupInfo</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<udata>misc data</udata>
</qdbapi>