Create a Note Associated with a Domain Record

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Insert new note record by providing the parent domain along with the attributes for the new note record.

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.'

integer

required

Numeric primary identifier of the domain record. This value specifies the exact instance the resource created by this endpoint will be associated with.

For example, if {domain} is "Claim" and {id} is 1234, the Note created by this endpoint will be associated with Claim 1234.

Query Params

fireEvents

boolean

Defaults to false

Default is false.

echoFields

string

Defaults to NoteID,EntryDate,AuthorName

Optional comma separated list of fields to be returned in the results should the insert process successfully. This can be used as a confirmation of key field values without having to make a separate API call. Any valid field from the Notes domain schema can be used.

Body Params

RAW_BODY

json

required

Defaults to { "Subject": "optional subject line goes here", "Body": "Required Body for Note goes here" }

Ensure the schema you provide here matches the schema of the Notes domain. The only required field is Body. Full data dictionary is available here.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK