Agent Endpoint

Update an agent endpoint

Changed on

Updates an existing agent endpoint by its ID. Only environment and outboundDialType can be modified.

put/v1/agent/endpoint/{endpointId}

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/agent/endpoint/{endpointId}
  • Auth
    HTTP bearer

Path parameters

endpointIdstring required

The ID of the agent endpoint to update

Request body

environmentstring

Environment name

outboundDialType'NONE' | 'HTTP_REQUEST'

Outbound dial type: NONE or HTTP_REQUEST

outboundDialHttpRequestDefinitionIdstring uuid nullable

ID of the HTTP request definition for outbound dialing

Response

The updated agent endpoint

Changes

    • warning

      added the new DAILY enum value to the / response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new GOOGLE_CES enum value to the / response property for the response status

    • warning

      added the new KORE enum value to the / response property for the response status