API_ChangeRecordOwner

Overview

Use API_ChangeRecordOwner to change the owner of a record.

In Quick Base, a person who creates a record is the record owner. You can set up roles that restrict a record's view/modify access to the record owner. On occasion, you may need to transfer record ownership from one user to another. If you are using a technical support application, for instance, you might want to transfer ownership of a support incident (record) from one tech support rep to another.

You must have Full Administration rights on the application to use this call.

top

Request parameters

Parameter Value Required?

rid or key

The record ID. Every record in every table has a unique rid.

Normally, the record ID is the key field for the record. If you set your record's key field to a field OTHER than the record id (rid), you should use the key parameter rather than rid.

yes

newowner

Specifies the user to whom you are transferring ownership. You can specify either of the following:

  • the user's Quick Base user name

  • the user's email address

yes

ticket

A valid authentication ticket.

The authentication ticket is returned via the API_Authenticate call.

yes, one of:

  • ticket
  • username/password
  • user token

usertoken

A user token – this is a ticket alternative, used for API access

yes, one of:

  • ticket
  • username/password
  • user token

apptoken

A valid application token.

yes, if required by the application

udata

A string value that you want returned. It will not be handled by Quick Base but it will be returned in the response.

no

top

Response values

Element Name Value

action

The originating request, for example, API_SetRecordOwner.

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.

top

Sample XML Request

POST https://target_domain/db/target_dbid HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_ChangeRecordOwner

<qdbapi>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
   <rid>3</rid>
   <newowner>Muggsy</newowner>
</qdbapi>

top

URL alternative

https://target_domain/db/target_dbid?a=API_ChangeRecordOwner&rid=3
&newowner=Muggsy&ticket=auth_ticket&apptoken=app_token

where target_domain is the domain against which you are invoking this call, for example, intuit.quickbase.com. Read about this notation.

top

Sample response

<?xml version="1.0" ?>
<qdbapi>
<action>api_changerecordowner</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <udata>mydata</udata>
</qdbapi>

 

Go back    |     |  

© 1999-2017 QuickBase, Inc. All rights reserved. Legal Notices.