Ramp: Create Custom Table column
Ramp customRecords.postDevApiConfigureCustomTableColumns: arguments, response, policy and SDK examples.
← Custom records operations · Get started
Operation ramp.post_dev_api_configure_custom_table_columns
Provider route: POST /developer/v1/custom-records/configure/custom-tables/{custom_table_name}/columns. 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"]["postDevApiConfigureCustomTableColumns"]>[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.postDevApiConfigureCustomTableColumns(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_configure_custom_table_columns(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.custom_table_name | string | Required within parent | |
body | Model | Required within parent | Expand Create Custom Table column — request body — body |
Referenced models: Create Custom Table column — 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 Create Custom Table column — response body |
Referenced models: Create Custom Table column — response body
Schemas
Section titled “Schemas”Create Custom Table column — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_id | string | Required within parent | The id of the created column |
Create Custom Table column — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"boolean": "#/components/schemas/DeveloperApiCreatePrimitiveColumnRequestBody", "custom_reference": "#/components/schemas/DeveloperApiCreateReferenceColumnRequestBody", "native_reference": "#/components/schemas/DeveloperApiCreateReferenceColumnRequestBody", "number": "#/components/schemas/DeveloperApiCreatePrimitiveColumnRequestBody", "text": "#/components/schemas/DeveloperApiCreatePrimitiveColumnRequestBody"}, "propertyName": "column_type_name"} |
$ (oneOf 1) | Model | Alternative | Expand Create Custom Table column — request body — body / column_type_name: boolean, number, text |
$ (oneOf 2) | Model | Alternative | Expand Create Custom Table column — request body — body / column_type_name: custom reference, native reference |
Referenced models: Create Custom Table column — request body — body / column_type_name: boolean, number, text, Create Custom Table column — request body — body / column_type_name: custom reference, native reference
Create Custom Table column — request body — body / column_type_name: boolean, number, text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_type_name | string | Required within parent | The type of the primitive column. One of: boolean, number, text |
label | string | Required within parent | The display name of the column |
name | string | Required within parent | The API name of the column, to be used when writing to this column |
Create Custom Table column — request body — body / column_type_name: custom reference, native reference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_type_name | string | Required within parent | The type of the reference column. One of: custom_reference, native_reference |
label | string | Required within parent | The display name of the column |
name | string | Required within parent | The API name of the column, to be used when writing to this column |
reference_args | Model | Required within parent | Expand Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args Arguments for creating a reference column. |
Referenced models: Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args
Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardinality | string | Required within parent | The cardinality of the reference. One of: many_to_many, many_to_one |
corresponding_column_label | JSON | Optional | |
corresponding_column_label (anyOf 1) | string | Alternative | The label of the corresponding column. Providing either corresponding column field opts into creating an archived backref column; omitted fields are generated only when a backref is created. Default: null |
corresponding_column_label (anyOf 2) | null | Alternative | |
corresponding_column_name | JSON | Optional | |
corresponding_column_name (anyOf 1) | string | Alternative | The API name of the corresponding column. Providing either corresponding column field opts into creating an archived backref column; omitted fields are generated only when a backref is created. Default: null |
corresponding_column_name (anyOf 2) | null | Alternative | |
foreign_table | JSON | Required within parent | The table that this column references. |
foreign_table (oneOf 1) | Model | Alternative | Expand Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args foreign table type: custom table |
foreign_table (oneOf 2) | Model | Alternative | Expand Extend Native Ramp table — request body — body |
Referenced models: Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args foreign table type: custom table, Extend Native Ramp table — request body — body
Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args foreign table type: custom table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
table_name | string | Required within parent | The name of the custom table |
type | string | Optional | Default: custom_table One of: custom_table |
Extend Native Ramp table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
table_name | string | Required within parent | The name of the native Ramp table One of: accounting_field_options, approver_groups, bills, business_entities, cards, contracts, departments, external_attendees, limits, locations, merchant_categories, purchase_order_line_items, purchase_orders, reimbursements, transactions, users, vendors |
type | string | Optional | Default: native_table One of: native_table |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_dev_api_configure_custom_table_columns. Catalog operation: post_dev_api_configure_custom_table_columns. 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"]