Upsert to Edit or Create a Domain Record

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Insert a new record or update an existing one based on the match fields and JSON payload provided. The endpoint receives a payload along with an optional set of match fields. It queries your domain using the specified fields and will either update the matching record if found or create a new one if no match exists. All match fields must be actual field names (not aliases) and must be present in the json payload.

Note About the BODY Parameter

When preparing the data in your request body, please ensure your object follows the required schema for the {domain} you are targeting. (read more about how to access domain data dictionaries.

Path Params

domain

string

required

This is the Domain Name as identified in the response of the /api/Domains endpoint. Ex: the "Claims" domain (DomainID 1) would be referenced by its name value of Claim. Values are case-sensitive. Client-defined Domains should start with "Custom."

Query Params

matchFields

string

required

A comma-separated list of field names used to identify an existing record for update during an upsert operation (for example, ReferenceNumber,LossDate).

Each field specified for matching must meet all of the following criteria:

The field must be an actual field name in the target domain (aliases are not allowed).
Field names are case sensitive.
Only text, numeric, or date fields are permitted. Coded or lookup fields are not allowed.
Every field listed in MatchFields must also be present in the upsert payload and contain a value.

At runtime, the values provided for the specified match fields are evaluated together to locate an existing record. The match criteria must resolve to exactly one existing record.

If exactly one record is found, that record will be updated.
If no matching records are found, a new record will be created.
If the match fields resolve to more than one existing record, the request will fail and an error will be returned, as the match criteria do not uniquely identify a single record.

fireEvents

boolean

Defaults to false

This field lets you decide whether creating this domain record 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

json

required

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

Ensure the schema you provide here matches the schema of your intended target domain. See Origami Data Dictionaries for domain-specific schemas.

If you have identified matchType fields, those field and value pairs must be present in your payload.

Response

200