This is an old revision of the document!
Table of Contents
1. Background & Objective
To support platform integration and workflow automation for MCW, CX Genie must provide open APIs for third-party systems to perform the following operations on form data:
- Retrieve form field metadata
- Create new form entries
- Update specific form entries
- Query all or filtered form data
- Archive form entries (internal use only)
These APIs will be applied in scenarios such as:
- Data synchronization
- Auto-fill features
- Self-service queries
2. API Security Design
2.1 workspace_token
Authentication All API requests must include the following field in the request payload:
"workspace_token": "your_token_here"
The system will verify the token against the corresponding Workspace’s permissions. Requests with invalid or missing tokens will return a 401 Unauthorized error.
2.2 Error Response Format
{
"error": "Invalid or missing workspace_token"
}