Batch Testing

Create batch test configurations, run batches of tests against multiple numbers or scenarios, and retrieve batch run results.

9 endpoints

POST/testing/batches

Create a new batch test configuration for running tests across multiple phone numbers.

Body Parameters

Name	Type	Required	Description
name	string	required	Display name for the batch
configId	string	required	Test configuration ID to use as the base flow
datasetId	string	required	Dataset ID containing the phone numbers to test

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"UK Regional Batch","configId":"cfg_abc123","datasetId":"ds_abc123"}' \
  https://api.nopaque.co.uk/testing/batches

Response

json

{
  "id": "batch_abc123",
  "name": "UK Regional Batch",
  "configId": "cfg_abc123",
  "datasetId": "ds_abc123",
  "status": "created",
  "createdAt": "2026-04-10T12: 00: 00Z"
}

GET/testing/batches

List all batch test configurations in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/batches

Response

json

{
  "batches": [
    {
      "id": "batch_abc123",
      "name": "UK Regional Batch",
      "status": "created",
      "createdAt": "2026-04-10T12: 00: 00Z"
    }
  ]
}

GET/testing/batches/{id}

Get a specific batch test configuration by ID.

Path Parameters

Name	Type	Required	Description
id	string	required	Batch ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/batches/batch_abc123

Response

json

{
  "id": "batch_abc123",
  "name": "UK Regional Batch",
  "configId": "cfg_abc123",
  "datasetId": "ds_abc123",
  "status": "created",
  "createdAt": "2026-04-10T12: 00: 00Z"
}

PUT/testing/batches/{id}

Update a batch test configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Batch ID

Body Parameters

Name	Type	Required	Description
name	string	optional	Updated display name
datasetId	string	optional	Updated dataset ID

Request

bash

curl -X PUT -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"EU Regional Batch"}' \
  https://api.nopaque.co.uk/testing/batches/batch_abc123

Response

json

{
  "id": "batch_abc123",
  "name": "EU Regional Batch",
  "updatedAt": "2026-04-10T12: 10: 00Z"
}

DELETE/testing/batches/{id}

Delete a batch test configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Batch ID

Request

bash

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/batches/batch_abc123

Response

json

{
  "message": "Batch deleted successfully"
}

POST/testing/batches/{id}/run

Start a batch test run. Executes the test flow against all phone numbers in the dataset.

Path Parameters

Name	Type	Required	Description
id	string	required	Batch ID

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/batches/batch_abc123/run

Response

json

{
  "id": "brun_def456",
  "batchId": "batch_abc123",
  "status": "running",
  "startedAt": "2026-04-10T12: 15: 00Z"
}

GET/testing/batches/{id}/runs

List all runs for a specific batch test.

Path Parameters

Name	Type	Required	Description
id	string	required	Batch ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/batches/batch_abc123/runs

Response

json

{
  "runs": [
    {
      "id": "brun_def456",
      "status": "completed",
      "passRate": 0.92,
      "startedAt": "2026-04-10T12: 15: 00Z"
    }
  ]
}

GET/testing/batch-runs

List all batch runs across all batches in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/batch-runs

Response

json

{
  "runs": [
    {
      "id": "brun_def456",
      "batchId": "batch_abc123",
      "status": "completed",
      "passRate": 0.92
    }
  ]
}

GET/testing/batch-runs/{id}

Get a specific batch run by ID with full results.

Path Parameters

Name	Type	Required	Description
id	string	required	Batch run ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/batch-runs/brun_def456

Response

json

{
  "id": "brun_def456",
  "batchId": "batch_abc123",
  "status": "completed",
  "totalNumbers": 25,
  "passed": 23,
  "failed": 2,
  "passRate": 0.92,
  "completedAt": "2026-04-10T12: 30: 00Z"
}