Create a research note

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

A brief summary. Will default to the name of the first uploaded attachment, should one exist.

string

Rich content of the note, in HTML format.

string
required

The ID of the user which authored the item. This parameter is not accepted when an OAuth access token issued using the Authorization Code Grant is used.

fields
object

A dictionary of field values, keyed by field apiIdentifier. The format of each field value will depend on the field type.

categories
array

An array of label IDs. The research note item will be tagged with these labels. Alias of the 'label' parameter.

categories
boolean

Set to false to lock the item, true to enable editing by users with whom it has been shared.

boolean

Set to true to prevent any further changes to the item.

migrationAttributes
array

A dictionary of attributes intended for the storage of legacy system data.

migrationAttributes
sharedUsers
array

An array of user IDs. The item will be shared with those users.

sharedUsers
sharedGroups
array

An array of user group IDs. The item will be shared with those groups.

sharedGroups
string
string
externalIds
array of objects
externalIds
labels
array

An array of label IDs. The research note item will be tagged with these labels. Alias of the 'categories' parameter.

labels
string

A hierarchical path to a label in the form of Branch/Sub-branch/Leaf. The item is tagged to the leaf label. Labels are matched strictly by name or else ignored.

labelPaths
array

A list of hierarchical paths to labels in the form of Branch/Sub-branch/Leaf. The item is tagged to each leaf label. Labels are matched strictly by name or else ignored.

labelPaths
unmatchedTags
array

A list of tags included in an emailed in note subject line that were not matched to an entity in Bipsync.

unmatchedTags
Response
200

Create result

Language
Credentials
OAuth2
URL
LoadingLoading…