Execute commands in best-effort batch

Validates all commands up front, then executes them sequentially. Async fire-and-forget commands are rejected. A 200 response can contain failed items, so clients must inspect results.

Authentication

AuthorizationBearer

Tenant/app API key or OAuth/JWT bearer token.

Query parameters

workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Request

This endpoint expects an object.

commandslist of objectsRequired

Response

Per-command batch results

totalinteger

succeededinteger

failedinteger

resultslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

1	const url = 'https://cessy.ai/api/rest/tenant-id/app-id/commands/batch';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"commands":[{"commandType":"UpdateUserProfile"}]}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"total": 1,
3	"succeeded": 1,
4	"failed": 0,
5	"results": [
6	{
7	"index": 0,
8	"status": "success",
9	"commandType": "UpdateUserProfile",
10	"scopeKey": "legacyScope123",
11	"eventsEmitted": 2,
12	"error": ""
13	}
14	]
15	}

Authentication

Headers

Query parameters

Request

Response

Errors