Add or Update the Code values for a Domain's Field

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Inserts a new code entry or updates an existing code entry within a domain field's code list. This endpoint allows you to programmatically manage the valid values available in coded/lookup fields (e.g., adding a new status code, updating a description on an existing code entry).

This endpoint handles one code record at a time. To upsert multiple code values, you must make separate API calls for each code entry.

The operation uses a match-based upsert pattern: you provide one or more matchFields that the system uses to search for an existing code record. If a match is found, the record is updated with the provided values. If no match is found, a new code record is inserted.

This endpoint operates on the underlying code table associated with the specified field, not on the parent domain entity itself. For example, upserting on Claim's Custom2Code field will insert/update a record in the code table that backs Custom2Code, not a Claim record.

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

fieldName

string

required

The case-sensitive name of the coded/lookup field on the domain whose code list you want to upsert into. Must be an association or MultiSelectCode field. Cannot be a static code list.

matchFields

string

required

A comma-separated string of one or more field names used to match existing records (e.g., ReferenceNumber, LossDate). The fields you provide here must be of simple, scalar data types (text, numeric, or date).

Body Params

RAW_BODY

json

required

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

A JSON dictionary of key-value pairs representing the field values to be set on the code record. Field names are case-sensitive and must correspond to fields on the code table entity (not the parent domain).

All fields specified in matchFields must be included in the body.

Example for updating the AccidentType codes used by the Claim domain:
POST /api/Claim/Codes?fieldName=AccidentType
{
"DisplayCode": "newCodeValue",
"Description": "Description goes here"
}

Response

200