Skip to main content
PUT
/
v1
/
agent
/
endpoint
/
{endpointId}
JavaScript
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const agentEndpoint = await client.agentEndpoint.update('endpointId');

console.log(agentEndpoint.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "PHONE",
    "value": "<string>",
    "environment": "<string>",
    "direction": "INCOMING",
    "outboundDialType": "NONE",
    "outboundDialHttpRequestDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
endpointId
string
required

The ID of the agent endpoint to update

Body

application/json

Input for updating an agent endpoint

​
environment
string

Environment name

​
outboundDialType
enum<string>

Outbound dial type: NONE or HTTP_REQUEST

Available options:
NONE,
HTTP_REQUEST
​
outboundDialHttpRequestDefinitionId
string<uuid> | null

ID of the HTTP request definition for outbound dialing

Response

The updated agent endpoint

​
data
object
required

Detailed agent endpoint response