Ramp: Append cells to Matrix table rows
Ramp customRecords.postDevApiMatrixAppendCells: arguments, response, policy and SDK examples.
← Custom records operations · Get started
Operation ramp.post_dev_api_matrix_append_cells
Provider route: POST /developer/v1/custom-records/matrix-tables/{table_name}/rows/-/append. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["customRecords"]["postDevApiMatrixAppendCells"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.customRecords.postDevApiMatrixAppendCells(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.custom_records.post_dev_api_matrix_append_cells(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.table_name | string | Required within parent | |
body | Model | Required within parent | Expand Append cells to Matrix table rows — request body — body |
Referenced models: Append cells to Matrix table rows — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Append cells to Matrix table rows — response body |
Referenced models: Append cells to Matrix table rows — response body
Schemas
Section titled “Schemas”Append cells to Matrix table rows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request for appending cells to Matrix rows. |
data | array | Required within parent | Rows with cells to append (many-to-many result columns only) |
data[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item |
ignore_duplicates | boolean | Optional | If true, existing duplicate cells and duplicate cells within the request are skipped instead of returning an error. Default: false |
Referenced models: Upsert Matrix table rows — request body — body data item
Append cells to Matrix table rows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for appending cells to Matrix rows. |
metadata | Model | Required within parent | Expand Append cells to Matrix table rows — response body — metadata Append counts |
Referenced models: Append cells to Matrix table rows — response body — metadata
Upsert Matrix table rows — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Input for writing a single Matrix row. |
inputs | array | Required within parent | Input column values (must include ALL input columns) |
inputs[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item inputs item |
results | array | Required within parent | Result column values (can be partial subset) |
results[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item results item |
Referenced models: Upsert Matrix table rows — request body — body data item inputs item, Upsert Matrix table rows — request body — body data item results item
Append cells to Matrix table rows — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells_appended | JSON | Required within parent | |
cells_appended (anyOf 1) | integer | Alternative | Number of cells appended |
cells_appended (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Upsert Matrix table rows — request body — body data item inputs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix input cell with column name and identifier. |
column_name | string | Required within parent | API name of the input column |
identifier | JSON | Optional | |
identifier (anyOf 1) | Model | Alternative | Expand List Matrix table rows — response body — data item results item identifier column name, value Identifier for the referenced native object (use for native_table columns) Default: null |
identifier (anyOf 2) | null | Alternative | |
number_identifier | JSON | Optional | |
number_identifier (anyOf 1) | JSON | Alternative | Number value identifier (use for number columns) Default: null |
number_identifier (anyOf 1) (oneOf 1) | number | Alternative | |
number_identifier (anyOf 1) (oneOf 2) | string | Alternative | |
number_identifier (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — response body — data item results item identifier column name, value
Upsert Matrix table rows — request body — body data item results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix result cell with column name and identifier (for input requests). |
column_name | string | Required within parent | API name of the result column |
identifier | JSON | Required within parent | |
identifier (anyOf 1) | Model | Alternative | Expand List Matrix table rows — response body — data item results item identifier column name, value Identifier for the referenced object (None to clear) |
identifier (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — response body — data item results item identifier column name, value
List Matrix table rows — response body — data item results item identifier column name, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifier for a native Ramp object (e.g., user, department). |
column_name | string | Required within parent | Column name to identify by (e.g., 'id', 'email') |
value | string | Required within parent | Value for identification |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_dev_api_matrix_append_cells. Catalog operation: post_dev_api_matrix_append_cells. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["custom_records:write"]