Sign in
bridge_phrases

Update Bridge Phrases

Update an existing bridge phrases config.

put/api/v1/bridge_phrases/

Request body

namestring required

The name of the bridge phrases config.

descriptionstring nullable

Description of the bridge phrases config.

idinteger required

The ID of the bridge phrases config to update.

edit_commentsstring nullable

Comments for the most recent edit.

Example request

{
  "name": "Default Bridge Phrases",
  "description": "Standard hold phrases for inbound line.",
  "config": {
    "phrases": {
      "messages": [
        "One moment, please.",
        "Let me check on that for you."
      ],
      "localized": {
        "es-US": {
          "messages": [
            "Un momento, por favor."
          ]
        },
        "fr-FR": {
          "messages": [
            "Un instant, je vous en prie."
          ]
        }
      }
    },
    "tools": [
      {
        "phrases": {
          "messages": [
            "One moment, please.",
            "Let me check on that for you."
          ],
          "localized": {
            "es-US": {
              "messages": [
                "Un momento, por favor."
              ]
            },
            "fr-FR": {
              "messages": [
                "Un instant, je vous en prie."
              ]
            }
          }
        }
      }
    ],
    "randomize_bridge_phrases": true
  },
  "id": 1,
  "edit_comments": "Added Spanish overrides for the transfer tool."
}

Response

Successful Response

namestring required

The name of the bridge phrases config.

descriptionstring nullable

Description of the bridge phrases config.

idinteger required

The ID of the bridge phrases config to update.

edit_commentsstring nullable

Comments for the most recent edit.

updated_atstring date-time required

Timestamp of the last update.

last_updated_bystring required

Email of the user who last updated this config.

Example response

{
  "name": "Default Bridge Phrases",
  "description": "Standard hold phrases for inbound line.",
  "config": {
    "phrases": {
      "messages": [
        "One moment, please.",
        "Let me check on that for you."
      ],
      "localized": {
        "es-US": {
          "messages": [
            "Un momento, por favor."
          ]
        },
        "fr-FR": {
          "messages": [
            "Un instant, je vous en prie."
          ]
        }
      }
    },
    "tools": [
      {
        "phrases": {
          "messages": [
            "One moment, please.",
            "Let me check on that for you."
          ],
          "localized": {
            "es-US": {
              "messages": [
                "Un momento, por favor."
              ]
            },
            "fr-FR": {
              "messages": [
                "Un instant, je vous en prie."
              ]
            }
          }
        }
      }
    ],
    "randomize_bridge_phrases": true
  },
  "id": 1,
  "edit_comments": "Added Spanish overrides for the transfer tool.",
  "agents_info": [
    {
      "id": 1,
      "name": "Test Agent"
    }
  ],
  "updated_at": "2026-07-02T00:00:00Z",
  "last_updated_by": "user@mail.com"
}

Changes