Ramp: Append cells to a Custom Table
Ramp customRecords.postDevApiAppendCustomRowCells: arguments, response, policy and SDK examples.
← Custom records operations · Get started
Operation ramp.post_dev_api_append_custom_row_cells
Provider route: POST /developer/v1/custom-records/custom-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"]["postDevApiAppendCustomRowCells"]>[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.postDevApiAppendCustomRowCells(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_append_custom_row_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 a Custom Table — request body — body |
Referenced models: Append cells to a Custom Table — 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 a Custom Table — response body |
Referenced models: Append cells to a Custom Table — response body
Schemas
Section titled “Schemas”Append cells to a Custom Table — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
metadata | Model | Required within parent | Expand Append cells to a Custom Table — response body — metadata |
Referenced models: Append cells to a Custom Table — response body — metadata
Append cells to a Custom Table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of rows to insert or update. All entries must have the same set of column names, with `null` provided to indicate that a value should not be set. |
data[] | Model | Each item | Expand Append cells to a Custom Table — request body — body data item |
Referenced models: Append cells to a Custom Table — request body — body data item
Append cells to a Custom Table — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inserted | JSON | Required within parent | |
inserted (anyOf 1) | integer | Alternative | |
inserted (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Append cells to a Custom Table — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The contents of the cells in the row. The column name should be the name of the column, and the contents should be the value to insert into the cell. When setting a cell to reference many rows, each reference must be a separate entry in the list. |
cells[] | Model | Each item | Expand Append cells to a Custom Table — request body — body data item cells item |
external_key | string | Required within parent | The external key of the row. |
Referenced models: Append cells to a Custom Table — request body — body data item cells item
Append cells to a Custom Table — request body — body data item cells item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contents | JSON | Required within parent | |
contents (anyOf 1) | JSON | Alternative | |
contents (anyOf 1) (oneOf 1) | Model | Alternative | Expand Append cells to a Native Ramp table — request body — body data item row |
contents (anyOf 1) (oneOf 2) | string | Alternative | Format: date-time |
contents (anyOf 1) (oneOf 3) | boolean | Alternative | |
contents (anyOf 1) (oneOf 4) | number | Alternative | |
contents (anyOf 1) (oneOf 5) | string | Alternative | |
contents (anyOf 2) | null | Alternative | |
name | string | Required within parent |
Referenced models: Append cells to a Native Ramp table — request body — body data item row
Append cells to a Native Ramp table — request body — body data item row
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_name | string | Required within parent | |
value | string | Required within parent |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_dev_api_append_custom_row_cells. Catalog operation: post_dev_api_append_custom_row_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"]