table-writeback

Derive what one destination record type can do

The legal write actions (including composite create-or-update), the fields records can be matched on, the supported write modes, and whether matching is possible at all: everything the export editor's action, match-key and write-mode controls are driven by.

Probes the LIVE connection, so expired credentials fail here with a message about the connection rather than at run time.

get/table-writeback/write-capabilities/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/table-writeback/write-capabilities/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

integration_idstring uuid required
record_typestring required

Response

Successful Response

actionsExportWriteAction[] required

The write actions this record type supports, including composite upsert.

bulk_actionsstring[] required

Action values with a synchronous bulk write method: the ones a batched export can actually use.

can_matchboolean required

Whether an existing record can be found by field value: the precondition for replay-safe creates. False means only blind creates are possible and the editor must say so.

identity_fields_by_actionobject required

Selectable match/identity fields per action value. An EMPTY list means the destination resolves identity dynamically (a database: any column), and the picker falls back to the discovered fields.

suggested_batch_sizeinteger nullable required

The destination's own recommended batch size, or None.

supports_bulkboolean required

Whether records can be written in batches.

update_modesstring[] required

Supported write modes (replace, patch, set_once) for update/upsert.

Changes

No recorded changes to this operation across all 1 revision of this API.