Skip to content

Ramp: Create a Matrix table

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

← Custom records operations · Get started

Operation ramp.post_dev_api_matrix_tables

Provider route: POST /developer/v1/custom-records/matrix-tables. 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"]["postDevApiMatrixTables"]>[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.postDevApiMatrixTables(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.post_dev_api_matrix_tables(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Create a Matrix table — request body — body

Referenced models: Create a Matrix 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 Create a Matrix table — response body

Referenced models: Create a Matrix table — response body

Create a Matrix table — request body — body
FieldTypePresenceDescription and constraints
$objectRootSchema for creating a Matrix table (Developer API).
input_columnsarrayRequired within parentInput columns that define the Matrix dimensions (references or number)
input_columns[]ModelEach itemExpand Create a Matrix table — request body — body input columns item
labelstringRequired within parentDisplay name for the Matrix table
nameJSONOptional
name (anyOf 1)stringAlternativeAPI name for the table
Default: null
name (anyOf 2)nullAlternative
result_columnsarrayRequired within parentResult columns that store Matrix outputs
result_columns[]ModelEach itemExpand Add a result column to an existing Matrix table — request body — body

Referenced models: Create a Matrix table — request body — body input columns item, Add a result column to an existing Matrix table — request body — body

Create a Matrix table — response body
FieldTypePresenceDescription and constraints
$objectRootResponse for creating a Matrix table.
table_idstringRequired within parentID of the created Matrix table
Create a Matrix table — request body — body input columns item
FieldTypePresenceDescription and constraints
$objectRootSchema for defining a Matrix input column (Developer API).
column_typeJSONRequired within parentDefines the type of input field used by the matrix
column_type (oneOf 1)ModelAlternativeExpand Create a Matrix table — request body — body / input_columns / item / column_type / type: native table
column_type (oneOf 2)ModelAlternativeExpand Create a Matrix table — request body — body / input_columns / item / column_type / type: number
labelstringRequired within parentDisplay name for the input column
nameJSONOptional
name (anyOf 1)stringAlternativeAPI name for the column
Default: null
name (anyOf 2)nullAlternative

Referenced models: Create a Matrix table — request body — body / input_columns / item / column_type / type: native table, Create a Matrix table — request body — body / input_columns / item / column_type / type: number

Add a result column to an existing Matrix table — request body — body
FieldTypePresenceDescription and constraints
$objectRootSchema for defining a Matrix result column (Developer API).
cardinalitystringRequired within parentCardinality enum for Pydantic schemas with lowercase values.

This enum uses lowercase values for API consistency while mapping
to the internal CardinalityEnum.
many_to_one or many_to_many for the result column
One of: many_to_many, many_to_one
labelstringRequired within parentDisplay name for the result column
nameJSONOptional
name (anyOf 1)stringAlternativeAPI name for the column
Default: null
name (anyOf 2)nullAlternative
native_tableModelRequired within parentExpand Add a result column to an existing Matrix table — request body — body native table
The native table this result references (only users, approver_groups, and accounting_field_options supported)

Referenced models: Add a result column to an existing Matrix table — request body — body native table

Create a Matrix table — request body — body / input_columns / item / column_type / type: native table
FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API input columns.

Allows: users, locations, departments, business_entities, accounting_field_options, vendors,
and merchant_categories.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe native table name for input columns: users, locations, departments, business_entities, accounting_field_options, vendors, merchant_categories.
One of: accounting_field_options, business_entities, departments, locations, merchant_categories, users, vendors
typestringOptionalDefault: native_table
One of: native_table
Create a Matrix table — request body — body / input_columns / item / column_type / type: number
FieldTypePresenceDescription and constraints
$objectRootNumber column type for Developer API input columns.
typestringOptionalColumn type discriminator
Default: number
One of: number
Add a result column to an existing Matrix table — request body — body native table
FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API result columns.

Only allows: users, approver_groups, and accounting_field_options.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe native table name for result columns: users, approver_groups, or accounting_field_options only.
One of: accounting_field_options, approver_groups, users
typestringOptionalDefault: native_table
One of: native_table

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