Delete a channel

Deletes a channel. Related records are cascade-deleted by the database.

DELETE/api/v1/{team_slug}/{app_slug}/channels/{channel_id}
API
Management
Updated
Apr 26, 2026

management-api:DELETE:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}

Deletes a channel. Related records are cascade-deleted by the database.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: DELETE
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}
  • Summary: Delete a channel
  • Description: Deletes a channel. Related records are cascade-deleted by the database.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
channel_idpathYesstringChannel ID
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200Channel deleted successfullyapplication/json (object)
400Invalid channel IDapplication/json (object)
404Channel not foundapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Message

PropertyTypeRequiredDetails
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "message": "string",
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: DELETE
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Channels
  • OpenAPI summary: Delete a channel

Delete a channel

# Delete a channel Deletes a channel. Related records are cascade-deleted by the database.
DELETE /api/v1/{team_slug}/{app_slug}/channels/{channel_id}
Purpose

Deletes a channel.

Required inputs

app_slug path team_slug path channel_id path

Primary response

200 ยท Channel deleted successfully

Operation key

management-api:DELETE:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `DELETE` - Path: `/api/v1/{team_slug}/{app_slug}/channels/{channel_id}` - Summary: Delete a channel - Description: Deletes a channel. Related records are cascade-deleted by the database. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:DELETE:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | channel_id | path | Yes | string | Channel ID | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Channel deleted successfully | application/json (object) | | 400 | Invalid channel ID | application/json (object) | | 404 | Channel not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "message": "string", "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `DELETE` - Path: `/api/v1/{team_slug}/{app_slug}/channels/{channel_id}` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:DELETE:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}` - OpenAPI tag: Channels - OpenAPI summary: Delete a channel