WhiteboardService
Archive Whiteboard
Archive or restore a collaborative whiteboard.
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/v1/collab/whiteboards/123e4567-e89b-42d3-a456-426614174000:archive' \
--header 'Accept: */*' \
--header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
--header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
--header 'X-API-SIGNATURE: YOUR_API_SIGNATURE' \
--header 'Content-Type: application/json' \
--data '{
"archived": false
}'Responses
{
"access": {
"permissions": {
"canEdit": false,
"canManage": false,
"canView": false
},
"role": "VIEWER"
},
"board": {
"accessVersion": "1",
"archivedAt": "2025-01-01T00:00:00Z",
"audience": "PRIVATE",
"boardId": "123e4567-e89b-42d3-a456-426614174000",
"createdAt": "2025-01-01T00:00:00Z",
"defaultRole": "VIEWER",
"initialSnapshot": {
"elements": [],
"version": 1
},
"ownerAccountId": "7563897446546",
"title": "My Trading Board",
"updatedAt": "2025-01-01T00:00:00Z"
}
}Board identifier as a UUID string.
Target archive state. True archives the board, false restores it.
Stable board identifier as a UUID string.
123e4567-e89b-42d3-a456-426614174000Board owner account public ID.
7563897446546Human-readable board title, max 200 characters and 400 bytes.
My Trading BoardDefault audience policy used when no explicit ACL entry matches.
PRIVATEDefault role granted by the audience policy. This is always VIEWER or EDITOR.
VIEWERMonotonic access version incremented when audience, default role, ACL, or archive state changes.
1TODO: description pending
Represents a null value.
Represents a double value.
Represents a string value.
Represents a boolean value.
Represents a structured value.
Represents a repeated `Value`.
Creation time in UTC.
2025-01-01T00:00:00ZLast update time in UTC.
2025-01-01T00:00:00ZArchive time in UTC. Unset when the board is active.
2025-01-01T00:00:00ZHighest resolved role for the caller.
VIEWERWhether the caller may view metadata and join the room.
falseWhether the caller may edit board content in the room.
falseWhether the caller may manage sharing and board settings.
false| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |