Description

This endpoint will allow you to create a new Hi Marley case note. This endpoint supports the ability to tag operators in case notes. For more information about case notes, please visit this page: Hi Marley - Case Notes

Service Name	Create Case Notes
Service Type	REST
Method	POST
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/v2/cases/:caseId/notes
Production URL	https://integration.himarley.io/api/v2/cases/:caseId/notes
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

- API Request
- API Response
  - Response Payload Example
  - Response Body Breakdown

API Request

Flow

Send API request with the path parameter of the Hi Marley Case ID
Include "noteText" and "author" in the request body
Hi Marley receives the request and validates the Case ID exists
Hi Marley creates case note with note text and author from body

Tagging Operators via API

This endpoint supports tagging operators, similar to the Hi Marley webapp. To tag operators, add the user's email to the noteText field in the request body with the @ symbol before an array containing the email address, such as @[example@tester.com]. The email address must match the email stored within the Hi Marley webapp.

Request Path Example

https://integration.uat.marley.ai/api/case/c808ba82-e2cb-4a92-9344-b924d79d2308/notes

Request Body Example

{
"noteText": "Hello @[testuser@example.com]",
"taggedUsers": ["testuser@example.com"],
"author": "adjuster@example.com"
}

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
caseId		The Case ID associated with the Hi Marley Case.	string	true	c808ba82-e2cb-4a92-9344-b924d79d2308	caseId exists within Hi Marley.

Request Body Breakdown

Property	Element	Description	Type	Required	Example
noteText		The body of the note to be included in the request. Any tagged user	string	true	"noteText": "Hello, how are you @[testuser@example.com]?"
author	email	Author of the note being passed by the API, should be the operator's email address	string	true	"author": "adjuster@example.com"
taggedUsers	email	Email address of an users tagged in the message body	array	false	"taggedUsers": ["testuser@example.com"]

API Response

Response Payload Example

{
    "archived": false,
    "mentionedUserIds": [
        "5bfa662f-2026-4bfa-be39-57a8ae7b083f"
    ],
    "authorId": "643bb2f8-f82d-4e71-94f0-fad78172024a",
    "plainText": "Hello @ExampleUser",
    "replies": [],
    "id": "05b620d7-d4f6-46fa-b1d0-ede778b0fd99"
}

Response Body Breakdown

Property	Element	Description	Type	Example
archived		Indicates whether the note has been archived or not. Will be false for new notes and true for deleted notes.	boolean	"archived": false
mentionedUserIds	id	Hi Marley internally generated id of the mentioned user	array	"mentionedUserIds": [ "5bfa662f-2026-4bfa-be39-57a8ae7b083f" ]
authorId	id	Hi Marley internally generated id of the author	string	"authorId": "643bb2f8-f82d-4e71-94f0-fad78172024a"
plainText		The body of the newly created note.	string	"plainText": "Hello @ExampleUser"
replies		This field will list any responses to your note. This will typically appear blank for new notes.	string	"replies": []
id	id	The note id. Can be used for other case note API endpoints.	string	"id": "05b620d7-d4f6-46fa-b1d0-ede778b0fd99"

Common Errors to Handle

[404] Case Not Found - More Details

Create Case Note