POST /api/v2/cobrowse/sessions returns 400 Bad Request with valid conversation ID

NICE CXone API & Integrations
1

POST /api/v2/cobrowse/sessions

HTTP 400 Bad Request

We are building a custom agent desktop extension that needs to trigger a cobrowse session programmatically. The goal is to start the session from within an existing voice conversation context so the agent can see the customer’s screen. I have the conversation ID from the active call object in the SDK.

Here is the payload I am sending:

{
 "conversationId": "12345678-abcd-1234-abcd-1234567890ab",
 "providerId": "12345678-abcd-1234-abcd-1234567890ab",
 "applicationId": "98765432-abcd-1234-abcd-1234567890ab"
}

The error response is pretty vague:

{
 "code": "badRequest",
 "message": "Invalid request body",
 "details": []
}

I have verified the application ID is correct and published. The provider ID matches the user ID of the current agent. I am using the standard OAuth token for the application. The documentation says the conversationId is optional but recommended for linking. When I remove it, I get the same 400 error. I tried adding the type field set to cobrowse but that did not help either.

Is there a specific permission the application needs besides cobrowse:write? Or is the format of the IDs wrong? I am using the .NET SDK but switched to raw HTTP POST to debug this since the SDK wrapper just throws a generic exception.

2

You’re probably missing the type field or sending the wrong conversation ID format. Try adding "type": "cobrowse" to the payload and make sure you’re using the actual conversation ID from the active session, not the participant ID.

{
 "conversationId": "12345678-abc-def-ghi-jklmnopqrst",
 "type": "cobrowse"
}