Set variant group channel status

Sets a variant group's publishing status on a channel. Requires an existing channel membership row for the variant group. Allowed status values are `active`, `inactive`, and `incomplete`.

PATCH/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/variant-groups/{variant_group_id}/status

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/variant-groups/{variant_group_id}/status

Sets a variant group's publishing status on a channel. Requires an existing channel membership row for the variant group. Allowed status values are active, inactive, and incomplete.

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: PATCH
Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/variant-groups/\{variant_group_id\}/status
Summary: Set variant group channel status
Description: Sets a variant group's publishing status on a channel. Requires an existing channel membership row for the variant group. Allowed status values are active, inactive, and incomplete.
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.

Parameters4 parameters

Name	In	Required	Type	Description
team_slug	path	Yes	string	Team slug
app_slug	path	Yes	string	App slug
channel_id	path	Yes	string	Channel ID
variant_group_id	path	Yes	string	Variant group ID

Request bodyDocumented body

Required: Yes
Description: Channel status payload
Content: application/json (object)

Set Channel Status Payload

Property	Type	Required	Details
`status`	enum("active", "inactive", "incomplete")	Yes	-

Generated example (synthetic):

{
  "status": "active"
}

Responses5 statuses

Status	Description	Content
200	Updated variant group channel status	application/json (object)
400	Invalid request	application/json (object)
404	Channel or variant group not found	application/json (object)
422	Status validation failed	application/json (object)
500	Internal server error	application/json (object)

200 - object

Channel Variant Group Status Response

Property	Type	Required	Details
`data`	object	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Channel Variant Group Status

Property	Type	Required	Details
`channel_id`	string	No	-
`status`	string	No	-
`variant_group_id`	string	No	-

Generated example (synthetic):

{
  "data": {
    "channel_id": "string",
    "status": "string",
    "variant_group_id": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "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):

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

422 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "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):

{
  "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: PATCH
Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/variant-groups/\{variant_group_id\}/status
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Variant Groups
OpenAPI summary: Set variant group channel status