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.

Authentication

AuthorizationBearer

Access token, prefixed by Bearer .

Path parameters

vaultIDstringRequired
objectNamestringRequired

Request

This endpoint expects an object.
recordslist of objectsRequired
Record values and tokens.
vaultIDstringOptional
ID of the vault.
objectNamestringOptional
Name of the table.
tokenizationbooleanOptionalDefaults to false

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.<br /><br />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.
Allowed values:

Response

OK
recordslist of objects or null
Inserted records.

Errors