Create Operator v2

Description

Creates an operator in the Hi Marley system and sends a welcome email to the newly created user if the organization is not integrated with SSO. The "id" property is generated upon operator creation.

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

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Body Breakdown
• API Response
  • Response Payload Example
  • Response Fields Breakdown
• Common Errors to Handle

API Request

Flow

1. Send API request with the required body parameters: first, last, email.
   1. Optional properties: mobile.
2. Hi Marley receives the request and validates the user does not already exist; this is validated by checking if an existing email is present for that org.
3. Hi Marley responds with the user object data.

Request Example

https://integration.uat.marley.ai/api/v2/operators

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "mobile": "stringstri",
  "officeNumber": "stringstri",
  "roles": [
     "string",
     "string"
  ],
  "title": "string"
}

Request Body Breakdown

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	false	"mobile": "5552325555"
officeNumber	The office number for the operator.	string	false	"officeNumber": "8472220000"
roles	The role/s for the user. All caps. Hi Marley User Roles	array	false	"roles":[     "OPERATOR",     "ADMIN" ]
title	The title for the user.	string	false	"title": "Senior Claims Adjuster"

API Response 

Response Payload Example

https://integration.uat.marley.ai/api/v2/operators

{
  "id": "UUID"
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "mobile": "stringstri",
  "officeNumber": "stringstri",
  "roles": [
     "string",
     "string"
  ],
  "title": "string"
}

 

Response Fields Breakdown

Property	Description	Type	Required	Example
id	The Hi Marley UUID generated for the Operator upon creation.	string UUID	true	"id": "154024a9-08ae-4d08-880f-dfd4c6a6df1b"
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	false	"mobile": "5552325555"
officeNumber	The office number for the operator.	string	false	"officeNumber": "8472220000"
roles	The role/s for the user Hi Marley User Roles	string	false	"role": "operator"
title	The title for the user.	string	false	"officeNumber": "Senior Claims Adjuster"