Register or Update Omnichannel Contact

Register a guest user as a new omnichannel contact.
HTTP Method
URL
Requires Auth
POST
api/v1/omnichannel/contact
​yes​
Body
Argument
Example Value
Description
token *
4WcmeBE4spXx6AxrC
The contact token. Enter a random unique string as the value.
name *
Chris
The contact name.
email
[email protected]
The contact email.
phone
+93334432224444
The contact phone number.
contactManager
kim.jane
The contact manager's user name.
Example Call
curl --location 'http://local:host/api/v1/omnichannel/contact' \
--header 'X-Auth-Token: b5BKhblglC5OU0AfB_Tl9dKmOb0zXUvWK-nhNT_aE8V' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "434lxd7iss8yh8c4m80wh",
    "name": "Chris",
    "email": "[email protected]",
    "phone": "+91123456788",
    "contactManager": {
        "username": "kim.jane"
    }
}'
Example Response
{
    "contact": "7ipCD6NDtkkRDCiNM",
    "success": true
}
To update a contact, use the contact token created in the response.

HTTP Method	URL	Requires Auth
`POST`	`api/v1/omnichannel/contact`	`yes`

Argument	Example Value	Description
`token` `*`	`4WcmeBE4spXx6AxrC`	The contact token. Enter a random unique string as the value.
`name` `*`	`Chris`	The contact name.
`email`	`[email protected]`	The contact email.
`phone`	`+93334432224444`	The contact phone number.
`contactManager`	`kim.jane`	The contact manager's user name.

Last modified 25d ago