Create Channel Content Override

Creates or updates a channel content override for a product or variant. Supports text fields (name, description, slug, etc.) and relationship fields (category, collection, tag, attribute, image).

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

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

Creates or updates a channel content override for a product or variant. Supports text fields (name, description, slug, etc.) and relationship fields (category, collection, tag, attribute, image).

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: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content
  • Summary: Create Channel Content Override
  • Description: Creates or updates a channel content override for a product or variant. Supports text fields (name, description, slug, etc.) and relationship fields (category, collection, tag, attribute, image).
  • 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
team_slugpathYesstringTeam slug
app_slugpathYesstringApp slug
channel_idpathYesstringChannel ID
Request bodyDocumented body
  • Required: Yes
  • Description: Channel content data
  • Content: application/json (object)

Input Create Channel Content

PropertyTypeRequiredDetails
field_typeenum("name", "description", "short_description", "html_description", "html_short_description", "meta_title", "meta_description", "slug", "category", "collection", "tag", "attribute", "image")Yes-
parent_idstringYes-
parent_typeenum("product", "variant")Yes-
relationshipsstring[]No-
translationsobject[]No-
valuestringNo-

Localized Value

PropertyTypeRequiredDetails
language_codestringNo-
valuestringNo-

Generated example (synthetic):

{
  "field_type": "name",
  "parent_id": "string",
  "parent_type": "product",
  "relationships": [
    "string"
  ],
  "translations": [
    {
      "language_code": "string",
      "value": "string"
    }
  ],
  "value": "string"
}
Responses4 statuses
StatusDescriptionContent
200OKapplication/json (object)
400Bad Requestapplication/json (object)
404Not Foundapplication/json (object)
500Internal Server Errorapplication/json (object)

200 - object

Channel Content Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Channel Content
PropertyTypeRequiredDetails
created_atstringNo-
field_typestringNo-
idstringNo-
parent_idstringNo-
parent_typestringNo-
previewstring[]No-
relationshipsstring[]No-
translationsobject[]No-
updated_atstringNo-
valuestringNo-
Localized Value
PropertyTypeRequiredDetails
language_codestringNo-
valuestringNo-

Generated example (synthetic):

{
  "data": {
    "created_at": "string",
    "field_type": "string",
    "id": "string",
    "parent_id": "string",
    "parent_type": "string",
    "preview": [
      "string"
    ],
    "relationships": [
      "string"
    ],
    "translations": [
      {
        "language_code": "string",
        "value": "string"
      }
    ],
    "updated_at": "string",
    "value": "string"
  },
  "details": [
    "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: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Channels, ChannelContent
  • OpenAPI summary: Create Channel Content Override

Create Channel Content Override

# Create Channel Content Override Creates or updates a channel content override for a product or variant. Supports text fields (name, description, slug, etc.) and relationship fields (category, collection, tag, attribute, image).
POST /api/v1/{team_slug}/{app_slug}/channels/{channel_id}/content
Purpose

Creates or updates a channel content override for a product or variant.

Required inputs

team_slug path app_slug path channel_id path

Primary response

200 ยท OK

Operation key

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

## 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: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/content` - Summary: Create Channel Content Override - Description: Creates or updates a channel content override for a product or variant. Supports text fields (name, description, slug, etc.) and relationship fields (category, collection, tag, attribute, image). - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/content` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## 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 | ## Request body - Required: Yes - Description: Channel content data - Content: application/json (object) ### Input Create Channel Content | Property | Type | Required | Details | | --- | --- | --- | --- | | `field_type` | enum("name", "description", "short_description", "html_description", "html_short_description", "meta_title", "meta_description", "slug", "category", "collection", "tag", "attribute", "image") | Yes | - | | `parent_id` | string | Yes | - | | `parent_type` | enum("product", "variant") | Yes | - | | `relationships` | string[] | No | - | | `translations` | object[] | No | - | | `value` | string | No | - | #### Localized Value | Property | Type | Required | Details | | --- | --- | --- | --- | | `language_code` | string | No | - | | `value` | string | No | - | **Generated example (synthetic):** ```json { "field_type": "name", "parent_id": "string", "parent_type": "product", "relationships": [ "string" ], "translations": [ { "language_code": "string", "value": "string" } ], "value": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | OK | application/json (object) | | 400 | Bad Request | application/json (object) | | 404 | Not Found | application/json (object) | | 500 | Internal Server Error | application/json (object) | ### 200 - object #### Channel Content 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 Content | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `field_type` | string | No | - | | `id` | string | No | - | | `parent_id` | string | No | - | | `parent_type` | string | No | - | | `preview` | string[] | No | - | | `relationships` | string[] | No | - | | `translations` | object[] | No | - | | `updated_at` | string | No | - | | `value` | string | No | - | ##### Localized Value | Property | Type | Required | Details | | --- | --- | --- | --- | | `language_code` | string | No | - | | `value` | string | No | - | **Generated example (synthetic):** ```json { "data": { "created_at": "string", "field_type": "string", "id": "string", "parent_id": "string", "parent_type": "string", "preview": [ "string" ], "relationships": [ "string" ], "translations": [ { "language_code": "string", "value": "string" } ], "updated_at": "string", "value": "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):** ```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: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/content` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}/content` - OpenAPI tag: Channels, ChannelContent - OpenAPI summary: Create Channel Content Override