ShipMsgDocs
Contents

API reference

Sandbox

API reference descriptions are provided in English to preserve the exact published contract.

Execute an allow-listed request with an owned sandbox key

POST /v1/accounts/{AC}/sandbox-explorer

postV1AccountsByAcSandboxExplorerIdempotency-Key required200

Required scope: `api:access`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID
Request body (4 fields)
Request body
NameTypeRequiredDescription
apiKeySidstring (SK… SID)yes
bodyany
method"GET" | "POST" | "PUT" | "PATCH"yes
pathstring (max 1000 chars)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List canonical sandbox simulator fixtures

GET /v1/accounts/{AC}/sandbox/fixtures

getV1AccountsByAcSandboxFixtures200

Required scope: `sandbox:reset`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Reset sandbox data

POST /v1/accounts/{AC}/sandbox/reset

postV1AccountsByAcSandboxResetIdempotency-Key required202

Required scope: `sandbox:reset`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List failure-simulator scenarios and the selections in force

GET /v1/accounts/{AC}/sandbox/scenarios

getV1AccountsByAcSandboxScenarios200

Required scope: `sandbox:reset`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Choose the outcome of the next N sandbox sends

POST /v1/accounts/{AC}/sandbox/scenarios

postV1AccountsByAcSandboxScenariosIdempotency-Key required200

Required scope: `sandbox:reset`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID
Request body (3 fields)
Request body
NameTypeRequiredDescription
scenariostring (max 64 chars)yes
senderSidstring (WA… SID)
sendsinteger (1–100)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Cancel the scenario in force for a sandbox sender

DELETE /v1/accounts/{AC}/sandbox/scenarios

deleteV1AccountsByAcSandboxScenarios200

Required scope: `sandbox:reset`.

Parameters

Parameters
NameTypeRequiredDescription
senderSidquery · string (WA… SID)
ACpath · string (AC… SID)yesAccount SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.