Table Records

Update Table Records

Changed on

Update one or more records, addressed by id. Send a single object or an array; the array length is capped per deployment (10 by default) and a longer request answers 422.

Only the fields you send are changed. Writing a link field replaces that record's link set rather than adding to it.

patch/api/v3/data/{baseId}/{tableId}/records

Request

Query parameters

view_idstring

View Identifier. Scopes the write to a view; a view that does not belong to the table is rejected with 422.

linksAsLtar'true'

When set to true, Links fields in the response carry the linked records instead of a count.

fieldIdOnResult'true'

When set to true, record fields are keyed by field id instead of field title. Useful when titles may change or are not unique in the caller's model.

Headers

xc-tokenstring required

API Token. Refer here to know more

Request body

OR

Response

OK

warningsstring[]

Present when part of the write was not applied, e.g. computed fields named in the payload.

ignored_fieldsstring[]

Titles of computed fields (Formula, Lookup, Rollup, ...) named in the payload. Their values are calculated, so they were not written.

Changes

    • info

      added the new optional query request parameter fieldIdOnResult

    • info

      added the new optional query request parameter linksAsLtar

    • info

      added the new optional query request parameter view_id

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status