updatemicroapprow
description
Modify an existing row in a Microapp. The JSON body consists of rowID and rowData. The field names need to match (case sensitive) to the Buzzy field labels.
parameters
The X-Auth-Token
and X-User-Id
are derived from the values authToken
and userId
returned from the login endpoint and are used in the HTTP header.
rowID
- required, the the row to be updated's ID.
rowData
- required, JSON object that has properties matching to the fields to be updated.
userID
- optional parameter to change the row's "creator"
Resource
{
"rowID":"<insert microapp row id here>",
"rowData":{
"ExampleFieldName":"ExampleValue"
}
}
response
Returns the status of the request
Basic Update Example
POST /api/updatemicroapprow
X-Auth-Token:<insert token here>
X-User-Id:<insert user id here>
{
"rowID": "<insert row ID here>",
"rowData": {
"Name": "Updated Organization Name"
}
}
Linked Table Field Update Example
When updating linked table (cross app) fields, provide the complete linked field structure:
POST /api/updatemicroapprow
X-Auth-Token:<insert token here>
X-User-Id:<insert user id here>
{
"rowID": "<insert row ID here>",
"rowData": {
"assignedUser": {
"crossAppRowID": "new-user-row-id",
"value": {
"label": "name",
"value": "Jane Doe"
}
},
"marketplaceListing": {
"crossAppRowID": "listing-row-id",
"value": {
"label": "listingName",
"value": "Advanced AI Analytics Platform"
}
}
}
}
Important Notes:
To update a linked table field, provide the new
crossAppRowID
and correspondingvalue
To clear a linked table field, set the field to
null
or omit it fromrowData
The
value.label
should match a field name in the linked tableThe
value.value
should be the display value from that field
You should get back:
{
"status": "success"
}
See Also
Common API Examples - See this operation in all three API formats
microappdata/row - Understanding linked table field structure
insertmicroapprow - Inserting linked table fields
Last updated