Bulk Insert - Create Multiple Domain Records

post

https://{environment}.origamirisk.com/OrigamiApi/api/{domain}/BulkInsert

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Insert a batch of new records in a single API call by specifying the target {domain} and providing an array of objects. Each object should represent a single record in JSON format and must conform to the schema defined for the target domain.

There is a configurable cap on the number of records that can be processed per API call. If this cap is exceeded, an exception will be raised and no records will be processed. For most clients, the default cap is 25 records per API call, though this limit may vary depending on client-specific configurations.

Path Params

domain

string

required

This should match to the Domain Name in the system. It is case-sensitive. For Client Defined Entities it should start with 'Custom.'

Query Params

fireEvents

boolean

Defaults to false

This field lets you decide whether creating this domain record(s) should trigger a corresponding system event. If you’ve got external workflows or Data Entry Events and you don’t want them firing, be sure to set the value to false.

echoFields

string

This field lets you customize the shape of your response object. Just pass in a comma-separated list of the field names or attributes you want returned if the insert is successful. It’s a great way to confirm that your insert worked and get back the specific values you care about without having to make a separate API call. Think of it as a personalized snapshot of your newly created record.

Body Params

RAW_BODY

array of jsons

required

Defaults to { "Field1" : "Value1", "Field2" : "Value2" }

Ensure that the schema you provide here matches the schema defined for your intended target domain. Field names and data types must align exactly with the domain’s data model.

See Origami Data Dictionaries for domain-specific schemas.

For clarity, the sample below illustrates multiple records, where each individual record is represented as an {object} within the [] array:

[
  {
    "Field1": "Value1",
    "Field2": "Value2"
  },
  {
    "Field1": "ValueA",
    "Field2": "ValueB"
  }
]

RAW_BODY*

Response

200