Skip to product menu
Skip to main content

Edit the Operator Details

Description

This API can be used to update the details of any existing operator.

Request Payload

  • nick_name: The nickname of the operator (Values: String)
  • first_name: First name of the operator (Values: String)
  • last_name: Last name of the operator (Values: String)
  • description: Description of the operator (Values: String)
  • mobile: The mobile number of the operator
  • phone: The phone number of the operator
  • role: The role of the operator in your firm (Values: Administrator|Supervisor|Associate)
  • time_zone: The time zone of the operator
  • language: Language of the operator (Values: Valid language code)
  • maximum_concurrent_chat: Set the maximum concurrent chat limit for the operator (Values: 0|1|2|3|4|5|7|10|25|unlimited)
  • date_of_birth: Date of birth of the operator (DD/MM/YYYY)
  • is_chat_enabled:  Is chat enabled for the operator or not
  • street: The street mentioned in the address of the operator
  • city: The city of the operator
  • state: The state of the operator
  • country: The country of the operator (Values: Valid country code)
  • pin_code: Pincode of the operator

OAuth Scope:

SalesIQ.operators.UPDATE

URL:

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screen name}/operators/{operator id}

Example:

Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/operators/32308000000003031

Payload

Copied{
	 "maximum_concurrent_chat" : "unlimited",
	"nick_name" : "patty",
	 "role": "Administrator",
	"language" : "fr",
	"first_name" : "Patricia",
	"mobile" : "8907265346"
	"phone" : "8105232349"
	"description" : "Hi! I'm Patricia. You can ask your queries and they'll be answered in a jiffy!"
	"date_of_birth" : "08-12-1963"
	"time_zone" : "America/Los_Angeles"
	"last_name" : "Boyle"
}

Success Response

Copied{
  "url": "/api/v2/zylker-inc/operators/32308000000003031",
  "object": "operator",
  "data": {
    "date_of_birth": "08-12-1963",
    "is_chat_enabled": "true",
    "first_name": "Patricia",
    "mobile": "8907265346",
    "is_enabled": "true",
    "nick_name": "Patty",
    "state": "Texas",
    "email_id": "patricia@zylker.com",
    "phone": "8105232349",
    "status_code": "1",
    "pin_code": "",
    "status_message": "Available",
    "street": "",
     "notify": {
                      "new_visit": "true",
                       "return_visit": "true"
                   },
    "maximum_concurrent_chat": "10",
    "is_owner": "false",
    "id": "30000000000005",
    "is_confirmed": "false",
    "country": "us",
    "language": "en",
    "is_deleted": "false",
    "city": "Austin",
    "description": "Hi! I'm Patricia. You can ask your queries and they'll be answered in a jiffy!",
    "last_name": "Boyle",
    "created_time": "1524458507054",
    "wms_id": "PB_5492040_30000000000005",
    "modifed_time": "1524458507054",
    "departments": [
      "30000000000017"
    ],
    "time_zone": "America/Los_Angeles",
    "role": "Administrator",
    "image_url": "/api/v2/zylker-inc/downloads/45aab034a5d2329451f11b2448d12aab8fd1f3b5222ce6f1?purpose=operator_image"
  }
}