Take Inquiry

Join an open inquiry.

HTTP MethodURLRequires Auth

POST

/api/v1/livechat/inquiries.take

Body Parameters

KeyExample ValueDescription

inquiryId*

ByehQjC44FwMeiLbX

The inquiry ID.

userId

yuhehQjCfsd876sfd

The user's (agent) ID who is taking the inquiry. This is an optional parameter.

If the userId is provided, the user must have the view-l-room permission.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/livechat/inquiries.take \
     -d '{ 
          "inquiryId": "ByehQjC44FwMeiLbX"}'

Example Response

{
    "success": true
}

Change Log

VersionDescription

1.2.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.