Standard API request and response format
All inbound API calls use one standard action/data JSON format.
Request format
Send JSON with action, optional idempotency_key, and data. The action tells BOS what to do; data contains the details.
Example actions
- contact.create creates or updates a contact.
- order.create creates an order and moves the customer into support mode.
- order.update_status changes the order status.
- message.send sends a WhatsApp message through the company connection and saves it in AI Inbox.
Response format
Successful responses return success=true, action, request_id, and data. Failed responses return success=false, error_code, message, and request_id for debugging.