Common API Structures

Table of Contents

Case Response Payload

Case JSON Transcript Payload

Translation Object

Operator (v2) Payload

Case Response Payload

Property	Required	Element	Description	Type	Required	Example
caseData	true	claimNumber	Fields associated to claim/policy record.	string	true (onlyclaimcaseType)	"claimNumber":"0002383632"
		dateOfLoss		string	false	"dateOfLoss":"2022-05-25T16:00:00.000Z"
		policyNumber		string	true (only policycaseType)	"policyNumber":"0002383632"
		deductible		string	false	"deductible":"3197"
		brand	Subsidiary/Underwriter associated with case	string	true (only if brands are in-use)	"brand":"TestBrand1"
		lineOfBusiness	Line Of business associated with the Hi Marley case	object	false	"lineOfBusiness": {       "type": "personal",       "subtype": "auto" }
caseType	true		The type of Hi Marley Case. case claim policy	enum		"caseType": "claim"
businessName	false		Name of associated business for contact	string		"businessName": "Truckers United Co."
createdBy	false	email	The email of the person with active Hi Marley Account.	string	true	"createdBy":{"email":"[e-mail]"}
creationSource	true		Read-Only Enum indicating where the case originated from. PublicApi WebApp	enum		"creationSource":"PublicApi"
customer	true	id	The identifier generated and assigned to the customer.	string	true	"id": "998213a1-d6f4-4821-b011-f6f5bdb57884"
		first	The customers given name.	string	true	"first": "Jasonnn"
		last	The last name of the person assigned to the Hi Marley case.	string	true	"last": "Bourneee"
		email	The customers email address.	string	false	"email": "[e-mail]"
		mobile	The customers mobile number.	string	true	"mobile": "[phone]"
		role	The customers role. Always set to enduser.	enum	true	"role": "enduser"
		optStatus	The current opt status for the customer.	boolean	true	"optStatus": true
		optStatusDetail	Description of the current opt status for the customer.	string	true	"optStatusDetail": "OPTED_IN"
primaryContact	false	first	The first name of the person assigned to the Hi Marley case.	string	true	"first":"Joe"
		last	The last name of the person assigned to the Hi Marley case.	string	true	"last":"Loop"
		email	The email of the person assigned to the Hi Marley case.	string	true	"email":"[e-mail]"
privacy	true		The case privacy status. public private-redacted	enum		"privacy": "public"
languagePreference	true		The preferred language for the current Hi Marley case.	enum		"languagePreference": "en"
marleyNumber	true		Number assigned the Hi Marley case based on the number pool.	string		"marleyNumber": "[phone]"
secondaryOperators (array)	true (can be empty)	email	The email of the person assigned to the Hi Marley case.	string	false	"email": "[e-mail]"

Case JSON Transcript Payload

The case JSON Transcript includes the Case Response Payload and the messages array below.

Array	Element per Item	Description	Type	Example
messages	id	UUID for Message	string	"id":"8f0feae4-1331-482d-a775-7e6db32fb933"
	type	text - text message  image - picture file - videos	enum	"type": "text"
	formatting	Indicator if it comes from Marley ai or a user standard ai	enum	"formatting": "standard"
	data	Original Message Text	string	"data": "hi"
	channelSource	marley - operator in webapp mobile - customer texting	enum	"channelSource": "marley"
	createdAt	Time when message was created	dateTime	"createdAt": "2023-03-09T14:48:44.582Z"
	dateFormatted	createdAt formatted as MM-DD-YYYY	string	"dateFormatted": "03-09-2023"
	timeFormatted	createdAt formatted as  hh:MM:SS		"timeFormatted": "9:48:44 AM EST"
	author	User object for creator of message	object	"author": { "_id": "d7827444-ff66-420a-a6af-62016ccbe3b6", "role": "operator", "profile": { "firstName": "Steven", "lastName": "Colon" } }
	translations	All translations for original message Translation Object Breakdown	array	"translations": [ { "translatedMessage": "salut.", "sourceLanguage": "en", "destinationLanguage": "fr" } ]

Translation Object

Object	type	Element Per Item	Description	Type	Required	Example
translations	array	translatedMessage	Message Text translated from source to destination language	string	true	"translatedMessage": "salut."
		sourceLanguage	Original message language	enum		"sourceLanguage": "en"
		destinationLanguage	Translated language set	enum		"destinationLanguage": "fr"

Operator (v2) Payload

Property	Description	Type	Required	Example
firstName	The given name for the operator.	string	true	"first": "stone"
lastName	The surname for the operator.	string	true	"last": "cold"
email	The unique email for the operator.	string	true	"email": "[e-mail]"
mobile	The mobile number for the operator.	string	true	"mobile": "5552325555"
officeNumber	The office number for the operator.	string	false	"officeNumber": "8472220000"
roles Array	The role/s for the user. All Caps. https://himarley.zendesk.com/hc/en-us/articles/360049779194-User-Roles	enum Array	false	"roles":[     "OPERATOR",     "ADMIN" ]
title	The title for the user.	string	false	"title": "Senior Claims Adjuster"