Create Operator
Description
This API can be used to create a new operator.
Requested Payload
Mandatory:
- email_id: The email address of the operator (Values: tricia@zylker.com)
- role: Role of the operator (Values: Administrator|Supervisor|Associate)
- departments: The department of the operator (Values: "6000000000017")
- is_monitored: Is the chat monitor enabled for the operator or not (Values: true|false)
Others:
- is_chat_enabled: Is the chat enabled for the operator (Values: true|false)
- 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 about the operator (Values: String)
- mobile: The mobile number of the operator
- phone: The phone number of the operator
- time_zone: The time zone of the operator
- language: Language of the operator (Values: Valid language code)
OAuth Scope:
SalesIQ.operators.CREATE
URL:
Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screen name}/operatorsExample:
Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/operatorsPayload
Copied{
"email_id": "patricia@zylker.com",
"role": "Associate",
"departments": ["38000000000017"],
"is_monitored": "true"
}Success Response
Copied{
"url": "/api/v2/zylker/operators",
"object": "operator",
"data": {
"date_of_birth": "10-02-1981",
"is_chat_enabled": "true",
"first_name": "Patricia",
"mobile": "0987756453234",
"is_enabled": "true",
"nick_name": "patty",
"wms_id": "LD_55158025_33290000000638003",
"type": "1",
"state": "California",
"email_id": "patricia@zylker.com",
"modified_time": "1535524459968",
"phone": "0987655434556",
"status_code": "1",
"status_message": "Available",
"role": "Administrator",
"street": "14, west coast lane",
"notify": {
"new_visit": "true",
"return_visit": "true"
},
"pincode": "9087",
"is_owner": "false",
"id": "33290000000638003",
"is_confirmed": "false",
"language": "en",
"country": "us",
"is_deleted": "false",
"description": "Love Exploring and assisting!",
"city": "Los Angels",
"last_name": "Williams",
"maximum_concurrent_chat": "0",
"created_time": "1535524459968",
"image_url": "/api/v2/integtest/downloads/0_33290000000638003?purpose=operator_image",
"time_zone": "GMT-7"
}
}