Update Operator

Description

This API allows you to update an Operator at your org.

Service Name	Update Operator
Service Type	REST
Method	PATCH
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/v2/operators/:id
Production URL	https://integration.himarley.io/api/v2/operators/:id
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

API Request

Flow

1. Send API request with the required body parameters.
2. Hi Marley receives the request and matches  the user profile off of the required parameters sent.
3. Hi Marley updates the user object data.
4. Hi Marley responds with the user object data.

Request Example

https://integration.uat.marley.ai/api/v2/operators/154024a9-08ae-4d08-880f-dfd4c6a6df1b

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",  //only for non-sso
  "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

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "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	array	false	"role": "operator"
title	The title for the user	string	false	"officeNumber": "Senior Claims Adjuster"