Skip to main content
DELETE
Delete an Apple Messages for Business agent

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string<uuid>
required

The AMB agent id (UUID).

Response

Deletion acknowledgement — data.id plus deleted: true; registry row removed when the agent's business_id was registered.

Deletion acknowledgement — data.id plus deleted: true; registry row removed when the agent's business_id was registered.

data
object
meta
object