API
Org settings
Botyard REST API endpoints for org settings.
6 endpoints in this group. Every request authenticates with an API key; see the API reference for the other groups.
- Get Inbox Settings:
GET /v1/orgs/{org_id}/settings/inbox - Put Inbox Settings:
PUT /v1/orgs/{org_id}/settings/inbox - Get Scanner Settings:
GET /v1/orgs/{org_id}/settings/scanner - Put Scanner Settings:
PUT /v1/orgs/{org_id}/settings/scanner - Get Push Settings:
GET /v1/orgs/{org_id}/settings/push - Put Push Settings:
PUT /v1/orgs/{org_id}/settings/push
Pin Org App
Pin a Bot Page for the authenticated user. Pins are per-user, so only USER actors have them — API-key/bot callers are a no-op, mirroring ``pin_conversation``. The pin is idempotent. The visibility check runs **before** the actor-type short-circuit, so a non-user principal still gets a 404 for an exposure it cannot see rather than a 204 that quietly confirms nothing.
Get Inbox Settings
Get the org's Inbox settings. Returns defaults when unset.