Description

The Invite Participant allows carriers with Multi-Party Texting to add an additional participant to an active Hi Marley Case.

Service Name	Invite Participant
Service Type	REST
Method	POST
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/case/:caseId/participants
Production URL	https://integration.himarley.io/api/case/:caseId/participants
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

API Request

Request Example

Note: "id" is equal to the enduser "contactId". This can be found for an existing Hi Marley contact by utilizing the Get Contact API or if adding a net-new Hi Marley user, this id can be created utilizing the Create Contact API.

{
"id": "d6a3426f-5d2e-411b-858f-fe39b562bb53",
"relationship": "PARTNER"
}

Request Field Breakdown

Property

Description

Type

Required

Example

The id of the target participant

string

true

"id": "d6a3426f-5d2e-411b-858f-fe39b562bb53"

relationship

The relationship of the participant to the claimant

Allowed relationships include:

"Parent", "Spouse/Partner", "Child" "Other Family", "Friend", "Agent", "Vendor", "Witness", "Attorney"

enum

true

"relationship": "Parent"

Response Payload Example

{
"participant": {
  "id": "389fb0b1-1f92-4325-a5c6-6ebeac2f495d",
  "first": "Jimmmy",
  "last": "Zimmer",
  "languagePreference": "en",
  "updatedAt": "2025-07-24T15:49:27.725Z",
  "createdAt": "2025-07-24T15:49:10.760Z",
  "mobile": "+15552176243",
  "optStatus": "PENDING_OPT_IN"
},
"relationship": "",
"role": "enduser",
"status": "PENDING"
}

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
participant	id	The Hi Marley UUID generated for the Contact upon creation	string UUID	true	"id": "0e2261fe-e05e-4049-b9d6-505a32272d42"
	first	The given name for the Contact	string	true	"first": "test"
	last	The surname for the Contact	string	true	"last": "name"
	mobile	The mobile number for the Contact	string	false	"mobile": "15552084238"
	optStatus	The Contacts Opt Status	enum	false	"optStatus": "OPTED_IN"
	languagePreference	The language preference for the Contact	enum	false	"languagePreference": "en"
	updatedAt	The time stamp for when the Contact is updated	dateTime	true	"updatedAt": "2024-07-15T15:41:54.684Z"
	createdAt	The time tamp for when the Contact is created	dateTime	true	"createdAt": "2024-07-15T15:41:54.684Z"
relationship		The relationship of the participant to the claimant	enum	true	"relationship": "Parent"
role		The customers role. Always set to enduser	enum	true	"role": "enduser"
status		The participant opt status	enum	true	"status": "PENDING"