Skip to main content
POST
Add an Agent conversation rule

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. REST requires a Sanctum API key. Separately, interactive MCP clients can use registered OAuth applications with PKCE and audience-bound workspace grants; those tokens are not REST credentials.

Headers

Idempotency-Key
string

Optional 8–120 character key for replayable mutations. Send the exact same method, URI, and body on retries; receipts expire after 24 hours.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required
agent
string<uuid>
required

Body

application/json
version
integer
required

Current rule-set version returned by the latest read. A stale version returns HTTP 409.

Required range: x >= 0
instruction
string | null
required
Maximum string length: 4000
title
string | null
Maximum string length: 120
template_key
enum<string> | null
Available options:
unsupported_topics,
sensitive_questions,
commitments,
escalation,
promoted_services,
null
enabled
boolean
default:true

Response

Successful data envelope.

data
any
required
meta
object
required