admin
organizations

Deprovision Organization Channels

Soft-delete an offboarded organization's live channels (agent links, region rows and number bindings go with them, each audited).

Separate from the platform flag, which is a pause: the org must already be off the agent platform, and no unpaused agent may still be linked to its channels. Defaults to a dry run listing what would go; POST {"dry_run": false} to apply. Re-runnable.

The numbers stay leased — only their messaging bindings are cleared, so they return to the eligible pool. A channel reported with has_messaging_number: false is the only record of that number on our side; note it down before applying.

post/admin/organizations/{organization_id}/deprovision-channels

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

organization_idstring required

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

dry_runboolean

Response

Successful Response

organization_idstring required
dry_runboolean required
channels_deletedinteger required
channels_without_messaging_numberinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.