Skip to main content
POST
Create Web Widget

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Body

application/json

Schema for API requests to create a new web widget (excludes organization_id).

agent_id
string
required
agent_version_id
string
required
domains
string[]
published
boolean
default:false
config
Config · object

Response

Successful Response

Web widget entity representing a web embed configuration.

id
string
required
organization_id
string
required
agent_id
string
required
agent_version_id
string
required
domains
string[]
required
published
boolean
required
config
Config · object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
created_by
string | null
modified_by
string | null