Guard Rails
Update Guard Rail
Update an existing guard rail configuration.
PATCH
/
v1
/
guard_rails
/
{guard_rail_id}
{
"config": {
"end_seconds": 45
}
}
{
"prompt": "Flag if the agent provides any medical advice, diagnosis, treatment recommendations, or medication suggestions"
}
{
"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" } }
]
}
]
}
{
"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
}
{
"data": null,
"errors": [
{
"error": "INVALID_PARAMETER",
"message": "Cannot update type of guard rail"
}
]
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Guard rail not found"
}
]
}
The
type field cannot be changed after creation. To change the type, delete the guard rail and create a new one.Headers
Path Parameters
Body Parameters
All fields are optional. Only include fields you want to update.Updated configuration object. For TCPA time-based guard rails, set
end_seconds to change the time window.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, orINBOUNDsource_id(string) - ID of the source to attach toactions(array) - Actions to take when the guard rail triggers
Response
The updated guard rail object containing
id, org_id, type, name, description, prompt, config, attachments, created_at, and updated_at.{
"config": {
"end_seconds": 45
}
}
{
"prompt": "Flag if the agent provides any medical advice, diagnosis, treatment recommendations, or medication suggestions"
}
{
"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" } }
]
}
]
}
{
"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
}
{
"data": null,
"errors": [
{
"error": "INVALID_PARAMETER",
"message": "Cannot update type of guard rail"
}
]
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Guard rail not found"
}
]
}
Docs for agents: llms.txt
Was this page helpful?
⌘I
{
"config": {
"end_seconds": 45
}
}
{
"prompt": "Flag if the agent provides any medical advice, diagnosis, treatment recommendations, or medication suggestions"
}
{
"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" } }
]
}
]
}
{
"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
}
{
"data": null,
"errors": [
{
"error": "INVALID_PARAMETER",
"message": "Cannot update type of guard rail"
}
]
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Guard rail not found"
}
]
}