Post
/api/v1/omnichannel/contact
Note: This endpoint will be replaced. Refer to the new API documentation for registering and updating contact for updated usage and features.
Register a guest user as a new omnichannel contact.
Permission required: view-l-room
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
"token": "434lxd7iss8yh8c4m80wh",
"name": "Chris",
"email": "chris@gmail.com",
"phone": "+91123456788",
"contactManager": {
"username": "kim.jane"
}
}object
token
string Required
The contact token. Enter a random unique string as the value. Use this same token to update the contact.
name
string Required
The contact name.
email
string
The contact email.
phone
string
The contact phone number.
contactManager
object
The contact manager's user name.
username
string
Responses
200
OK To update a contact, use the contact token created in the response.
Success Example
{
"contact": "7ipCD6NDtkkRDCiNM",
"success": true
}object
contact
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "Match error: Missing key 'token'"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Unauthorized
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string