Data APIRecords

Insert Records

Inserts a record in the specified table.

The time-to-live (TTL) for a transient field begins when the field value is set during record insertion.

Columns that have a string data type and a uniqueness constraint accept strings up to 2500 characters. If an inserted string exceeds 2500 characters, the call returns a token insertion error.

Path parameters

vaultIDstringRequired
ID of the vault.
tableNamestringRequired
Name of the table.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
recordslist of objectsOptional
Record values and tokens.
tokenizationbooleanOptional

If true, this operation returns tokens for fields with tokenization enabled.

upsertstringOptional

Name of a unique column in the table. Uses upsert operations to check if a record exists based on the unique column’s value. If a matching record exists, the record updates with the values you provide. If a matching record doesn’t exist, the upsert operation inserts a new record.

When you upsert a field, include the entire contents you want the field to store. For JSON fields, include all nested fields and values. If a nested field isn’t included, it’s removed.

homogeneousbooleanOptionalDefaults to false

If true, this operation mandates that all the records have the same fields. This parameter does not work with upsert.

byotenumOptionalDefaults to DISABLE

Token insertion behavior.

  • DISABLE: Tokens aren’t allowed for any fields. If tokens are specified, the request fails.
  • ENABLE: Tokens are allowed—but not required—for all fields. If tokens are specified, they’re inserted.
  • ENABLE_STRICT: Tokens are required for all fields. If tokens are specified, they’re inserted. If not, the request fails.
Allowed values:

Response

A successful response.
recordslist of objects or null
Identifiers for the inserted records.

Errors