> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bland.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Guard Rail

> Update an existing guard rail configuration.

> [!NOTE]
>
> The `type` field cannot be changed after creation. To change the type, delete the guard rail and create a new one.

### Headers

**authorization** `string` *required*

Your API key for authentication.

### Path Parameters

**guard\_rail\_id** `string` *required*

The unique identifier of the guard rail to update.

### Body Parameters

All fields are optional. Only include fields you want to update.

**name** `string`

Updated name for the guard rail (custom guard rails only).

**description** `string`

Updated description (custom guard rails only).

**prompt** `string`

Updated detection prompt (custom guard rails only).

**config** `object`

Updated configuration object. For TCPA time-based guard rails, set `end_seconds` to change the time window.

**attachments** `array`

Updated array of sources to attach this guard rail to. This replaces all existing attachments.

Each attachment requires:

* `source_type` (string) - Type of source: `PERSONA`, `PATHWAY`, or `INBOUND`
* `source_id` (string) - ID of the source to attach to
* `actions` (array) - Actions to take when the guard rail triggers

### Response

**data** `object`

The updated guard rail object containing `id`, `org_id`, `type`, `name`, `description`, `prompt`, `config`, `attachments`, `created_at`, and `updated_at`.

**errors** `array`

Any errors that occurred (null if none).

```json Update config theme={null}
{
  "config": {
    "end_seconds": 45
  }
}
```

```json Update prompt theme={null}
{
  "prompt": "Flag if the agent provides any medical advice, diagnosis, treatment recommendations, or medication suggestions"
}
```

```json Update attachments theme={null}
{
  "attachments": [
    {
      "source_type": "PERSONA",
      "source_id": "98765432-1234-1234-1234-123456789012",
      "actions": [
        { "type": "end_call" }
      ]
    },
    {
      "source_type": "PATHWAY",
      "source_id": "11111111-2222-3333-4444-555555555555",
      "actions": [
        { "type": "transfer", "config": { "phone_number": "+15551234567" } }
      ]
    }
  ]
}
```

```json Response theme={null}
{
  "data": {
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "org_id": "12345678-1234-1234-1234-123456789012",
    "type": "tcpa:ai_disclosure",
    "name": null,
    "description": null,
    "prompt": null,
    "config": {
      "end_seconds": 45
    },
    "attachments": [
      {
        "source_type": "PERSONA",
        "source_id": "98765432-1234-1234-1234-123456789012",
        "actions": [
          { "type": "end_call" }
        ]
      }
    ],
    "created_at": "2025-01-15T10:30:00.000Z",
    "updated_at": "2025-01-16T14:20:00.000Z"
  },
  "errors": null
}
```

```json Error Response (Cannot Update Type) theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "INVALID_PARAMETER",
      "message": "Cannot update type of guard rail"
    }
  ]
}
```

```json Error Response (Not Found) theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "NOT_FOUND",
      "message": "Guard rail not found"
    }
  ]
}
```

***

Docs for agents: [llms.txt](https://docs.bland.ai/llms.txt)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.