Skip to main content

Modify an RCS agent

PATCH 
/rcs_agents/:id

Modify an RCS agent

Request

Path Parameters

    id stringrequired

    RCS agent ID

Body

    profile_id uuidnullable

    Messaging profile ID associated with the RCS Agent

    webhook_url urlnullable

    URL to receive RCS events

    webhook_failover_url urlnullable

    Failover URL to receive RCS events

    agent_name string

    Human readable agent name

Responses

200: Successful response with the updated RCS agent

default: Unexpected error

Request samples


curl -L -X PATCH 'https://api.telnyx.com/v2/rcs_agents/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"profile_id": "4001932a-b8a3-42fc-9389-021be6388909",
"webhook_url": "http://example.com",
"webhook_failover_url": "http://example.com",
"agent_name": "Test Agent"
}'

Response samples


{
"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"
}
}