Skip to content

Ramp: Set values for rows of a Custom Table

Ramp customRecords.putDevApiCustomRow: arguments, response, policy and SDK examples.

← Custom records operations · Get started

Operation ramp.put_dev_api_custom_row

Provider route: PUT /developer/v1/custom-records/custom-tables/{custom_table_name}/rows. Alter supplies the connection’s credentials and routing.

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"]["putDevApiCustomRow"]>[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.putDevApiCustomRow(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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.put_dev_api_custom_row(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.custom_table_namestringRequired within parent
bodyModelRequired within parentExpand Append cells to a Custom Table — request body — body

Referenced models: Append cells to a Custom Table — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Set values for rows of a Custom Table — response body

Referenced models: Set values for rows of a Custom Table — response body

Set values for rows of a Custom Table — response body
FieldTypePresenceDescription and constraints
$objectRoot
metadataModelRequired within parentExpand Set values for rows of a Custom Table — response body — metadata

Referenced models: Set values for rows of a Custom Table — response body — metadata

Append cells to a Custom Table — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList 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[]ModelEach itemExpand Append cells to a Custom Table — request body — body data item

Referenced models: Append cells to a Custom Table — request body — body data item

Set values for rows of a Custom Table — response body — metadata
FieldTypePresenceDescription and constraints
$objectRoot
insertedJSONRequired within parent
inserted (anyOf 1)integerAlternativeThe number of rows inserted.
inserted (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedJSONRequired within parent
updated (anyOf 1)integerAlternativeThe number of rows updated.
updated (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Append cells to a Custom Table — request body — body data item
FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe 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[]ModelEach itemExpand Append cells to a Custom Table — request body — body data item cells item
external_keystringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
contentsJSONRequired within parent
contents (anyOf 1)JSONAlternative
contents (anyOf 1) (oneOf 1)ModelAlternativeExpand Append cells to a Native Ramp table — request body — body data item row
contents (anyOf 1) (oneOf 2)stringAlternativeFormat: date-time
contents (anyOf 1) (oneOf 3)booleanAlternative
contents (anyOf 1) (oneOf 4)numberAlternative
contents (anyOf 1) (oneOf 5)stringAlternative
contents (anyOf 2)nullAlternative
namestringRequired 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
FieldTypePresenceDescription and constraints
$objectRoot
column_namestringRequired within parent
valuestringRequired within parent

SDK function policy ID: ramp.put_dev_api_custom_row. Catalog operation: put_dev_api_custom_row. 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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.