API_CopyGroup
Don't forget to come by and check out our new RESTful JSON APIs, they can help you utilize and extend Quick Base with ease.
Overview
Use API_CopyGroup to duplicate an existing group with the same list of users and subgroups, and a different name and ID.
Request parameters
Parameter | Value | Required? |
|---|---|---|
gid | The id of the group to manage. | yes |
ticket | A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. | yes |
udata | Optional: Contains any udata value supplied in the request. | no |
name | The name of the new group. | yes |
description | A description of the group. Default is the description of the source group. | no |
gacct | The account used for the group. Default is the account for the source group. | no |
Response values
Element Name | Value |
|---|---|
action | The originating request, for example, API_CopyGroup. |
| description | The description of the new group |
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. |
gid | The id of the new group. |
| name | The name of the new group. |
| ManagedbyUser | In this case, whether the user making the request manages the group. |
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_CopyGroup
<qdbapi>
<udata>misc data</udata>
<ticket>auth_ticket</ticket>
<gid>1213.dsfj</gid>
<name>SalesTeamLeadsCopy</name>
<description>Copy of the current Sales Team Leads Group</description>
</qdbapi>
Sample HTTP Get Request
https://target_domain/db/main?a=API_CopyGroup&gid=1213.dsfj&name=SalesTeamLeadsCopy
&description=Copy%20ofthe%20current%20Sales%20Team%20Leads%20Group&ticket=auth_ticket
&udata=misc%20data
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.
Sample response
<qdbapi>
<action>API_CopyGroup</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<group id="1219.d47h">
<name>TestGroup</name>
<description>Copy of the current Sales Team Leads Group</description>
<managedByUser>true</managedByUser>
</group>
</qdbapi>
Did this help you? Give us a rating:
© 1999-2020 QuickBase, Inc. All rights reserved. Legal Notices.