API Response Format

Waplix endpoints return standardized JSON schemas. Depending on the route version, the response utilizes either a flat structure or a wrapped schema object.

1. Flat Response Structure

Used primarily by dedicated instance actions (detail, start, logout):

{
  "success": true,
  "instance_id": "12345",
  "display_name": "My Instance",
  "status": "connected"
}

2. Wrapped Response Structure

Used by creation, updates, messages, and newer v2 routes:

{
  "success": true,
  "message": "Operation successful",
  "data": {
    "instance_id": "12345",
    "status": "created"
  },
  "error": null
}