update_record - Qobra public API documentation

Change some cells of one record, and/or archive or restore it. Returns the record and the changes made. Only the fields listed change. Get the ids, the type each value takes and editable from get_data_table, the current values from list_data_table_records. Pass at least one of values or archived. On a record synced from an integration, the edit is kept as an overwrite with the synced value kept beside it, as in the web app, and a later sync keeps your edit. Statements are not recalculated by this call, just as when a record is edited in the web app. To refresh them, call recalculate_statements on the users and the period the record counts for. Without full write access to data tables, write through a view of the table shared with you with edit rights, passed as view_id: only a record the view’s filter holds can be changed. Requires write permission on data tables, or a view shared with edit rights. Every write is recorded in the audit trail as the Qobra MCP agent.

Parameters

Body

string

required

Id of the data table holding the record, from list_data_tables.

string

required

Id of the record, from list_data_table_records.

object[]

The cells to change, one per field; a field left out keeps its value. Omit to change only archived.

Show object properties

string

required

Id of the field, from get_data_table; its editable must be true.

string | number | boolean | string[]

required

The new value, in the shape read tools serve it: a number for amount / float / percentage (the ratio: 0.8 for 80%), true/false, an ISO date, text, one option label, a list of labels for a multipicklist, a user id or email, and for an object field the id of a record of the linked table (a table you can read), from list_data_table_records. null empties the cell (refused on the name field).

string

Amount only (ignored on other types): the company currency or one list_exchange_rates lists; the value is in this currency. Omit it to keep the cell’s currency (the company currency on a new record). The field’s currency_key column is read by imports, never on a write.

boolean

true archives the record, false restores it. Omit to leave it as it is.

string

One of the table’s adjustment_reasons (get_data_table): required when that list is not null, refused when it is null (use comment for a free-text note).

string

Free-text note kept in the record’s history.

string

Id of one of the table’s views, to write through. Required when your write access comes from shared views (only records its filter holds can be written); omit it with full write access.

The call is refused, with a message naming the problem, when no data table has the data_table_id, when no record of that table has the record_id (or none the view_id’s filter holds), when neither values nor archived is passed, when a field_id is unknown or listed twice, when a field is a lookup, when a value does not match its field’s type or picklist options — or, for a link, is not the id of a record of the linked table — when the name field is set to an empty or null value, when an amount’s currency is neither the company currency nor one list_exchange_rates lists, when the table requires a reason and none from its adjustment_reasons was passed, or when a reason is passed but the table takes none. A cell sent without a currency is never refused for its currency. To write an amount in a new currency, give that currency an exchange rate with update_exchange_rates first.

Example

{
  "data_table_id": "665f1c2e8a4b3d0012a7e9f1",
  "record_id": "665f1c2e8a4b3d0012a7ea10",
  "values": [
    { "field_id": "665f1c2e8a4b3d0012a7e9f3", "value": 15000, "currency": "EUR" },
    { "field_id": "665f1c2e8a4b3d0012a7e9f4", "value": null }
  ],
  "reason": "Amount correction",
  "comment": "Amount renegotiated after signature."
}

To archive a record without changing its values, pass only archived:

{
  "data_table_id": "665f1c2e8a4b3d0012a7e9f1",
  "record_id": "665f1c2e8a4b3d0012a7ea10",
  "archived": true
}

Response

Body

object

The table of the record; its fields name the record’s values in order.

Show object properties

string

The id to pass to tools that take one.

string

Deep link to open this data table in the Qobra web app.

string

Stable key in Qobra’s public API, for your own tooling (a display name can change). Never an identifier here — pass id instead.

string

object

Show object properties

string

One of: kombo, salesforce, pipedrive, microsoft_dynamics, hubspot, odoo, zoho, attio, postgresql, gcp-postgresql, snowflake, snowflake-keys, redshift, microsoft-azure-sql, microsoft-azure-synapse, bigquery, s3, sftp, netsuite, public_api.

object[]

The views you may query this table’s records through: pass one’s id as view_id to list_data_table_records. Empty when none is relevant.

Show object properties

string

object

Who can read this view, as roles and users with the level each holds. Resolved only by get_quota, get_data_table, get_identity and get_report (on a report’s own access), and only for callers who may share the resource. Null means not asked for or not yours to see, never an empty roster: a caller who may see it and finds nobody gets empty roles and users. get_identity lists the roles that reach every view through their access to the whole category once on the resource (category_roles), not on each view: there a role appears in roles only for the share it holds on this view, with its shared_access.

Show object properties

object[]

Show object properties

object

Show object properties

string

boolean

string

The level this role holds on the whole resource category, which reaches every view of it without a share — read (view it), write (edit and re-share it) or delete (also remove it), each level including the ones before it. Null when the role only got this view through a share. One of: read, write, delete.

string

The level granted to this role on this view specifically — read (view it), write (edit and re-share it) or delete (also remove it), each level including the ones before it. Null when the role reaches the view through its category access rather than a share. One of: read, write, delete.

object[]

Show object properties

object

Show object properties

string

The level this view is shared with the user at, individually, on top of whatever their role already grants — read (view it), write (edit and re-share it) or delete (also remove it), each level including the ones before it. One of: read, write, delete.

object[]

Show object properties

string

The id to pass to tools that take one.

string

Field data type; object is a link to another data table (see linked_to). One of: float, amount, percentage, string, picklist, multipicklist, bool, date, user, object, group, record_status.

string

The field’s description; null when none.

object

The table an object field points to; null on any other type.

Show object properties

string

The id to pass to tools that take one.

string

Name of the linked table, whether or not you may open it; null only when that table no longer exists.

boolean

Whether create_record / update_record can set this column; false for a lookup, which reads the linked record.

object

Show object properties

string

Deep link to this record in the Qobra web app.

string

integration (synced from a connected system) or local (created in Qobra). One of: integration, local, qobra, reporting.

string

The record’s id in its source system.

string

Integration tables only: Created, Overwritten or Archived. Null on a local table and on an untouched integration record.

boolean

string

object[]

One cell per column, in the order of data_table.fields: the Nth value belongs to the Nth field.

Show object properties

any

string

One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RMB, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WON, WST, XAF, XAG, XAU, XCD, XOF, XPD, XPF, XPT, XSU, YER, ZAR, ZMK, ZWL.

object[]

What this call changed, the archived state included (as ‘Active record’). Empty when nothing changed: nothing was written.

Show object properties

string

Name of the field that changed.

string | boolean | null

The value before the call, as the record’s history shows it.

string | boolean | null

The value after the call, as the record’s history shows it.

​Parameters

​Example

​Response

Parameters

Example

Response