Skip to main content
PATCH
/
messaging_rcs
/
agents
/
{id}
JavaScript
import Telnyx from 'telnyx';

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

const rcsAgentResponse = await client.messaging.rcs.agents.update('id');

console.log(rcsAgentResponse.data);
{
  "data": {
    "agent_id": "TestAgent",
    "user_id": "2ecf295b-36c6-4d43-ad05-71eb1e560518",
    "profile_id": "4001932a-b8a3-42fc-9389-021be6388909",
    "webhook_url": "http://example.com",
    "webhook_failover_url": "http://example.com",
    "agent_name": "Test Agent",
    "enabled": true,
    "created_at": "2024-01-01T12:00:00.000Z",
    "updated_at": "2024-01-01T12:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

RCS agent ID

Body

application/json
​
profile_id
string<uuid> | null

Messaging profile ID associated with the RCS Agent

Example:

"4001932a-b8a3-42fc-9389-021be6388909"

​
webhook_url
string<url> | null

URL to receive RCS events

Example:

"http://example.com"

​
webhook_failover_url
string<url> | null

Failover URL to receive RCS events

Example:

"http://example.com"

Response

Successful response with the updated RCS agent

​
data
object