Update visitor information
Description:
This API allows you to update the personal details of a visitor engaged in a chat, including their name, email, and phone number.
OAuth Scope: conversations.UPDATE
Method: PUT
Requested Payload:
- last_name - The visitor's name.
- email - The visitor's email address.
- phone - The visitor's phone/contact number.
Note:
- Use the Update Custom Information API to update additional visitor details besides name, email, and phone.
URL
Copiedhttps://{zohosalesiq_server_uri}/api/visitor/v1/{Screen name}/conversations/{conversationID}/visitor
Example
Copiedhttps://salesiq.zoho.com/api/visitor/v1/zylkerinc/conversations/666300030000479029/visitor
Payload
Copied{
"email": "larry@zylker.com",
"phone": "2384943201",
"last_name": "Larry"
}
Sample Response
Copied{
"url": "/visitor/v1/zylkerinc/conversations/666300030000479029/visitor",
"object": "conversations",
"data": {
"question": "Hello! I need help",
"id": "666300030000479029",
"visitor": {
"name": "Larry",
"id": "426628000007918043",
"country_code": "US",
"channel_details": {
"channel": "website",
"source": "https://www.zylker.com/help"
},
"supported_operations": [
"bot_chat",
"file_share",
"audio_call",
"video_call",
"screen_share",
"remote_share",
"edit_message",
"delete_message",
"reply_message",
"block_ip",
"article_share",
"read_recipients"
],
"ip": "121.244.**.**",
"phone": "2384943201",
"email": "larry@zylker.com",
"type": "contact",
"channel_name": "website",
"user_id": "$3382660261451297257"
}
}
}