Sign in
RCS

Modify an RCS agent

Updates the supplied configuration fields on the specified RCS agent.

patch/messaging/rcs/agents/{id}

Path parameters

idstring required

RCS agent ID

Request body

profile_idstring uuid nullable

Messaging profile ID associated with the RCS Agent

webhook_failover_urlstring url nullable

Failover URL to receive RCS events

webhook_urlstring url nullable

URL to receive RCS events

Example request

{
  "profile_id": "4001932a-b8a3-42fc-9389-021be6388909",
  "webhook_failover_url": "http://example.com",
  "webhook_url": "http://example.com"
}

Response

Successful response with the updated RCS agent

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.7

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 4XX

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 4XX

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog