createChannel

Example Query

mutation ExampleMutation($input: CreateChannelInput!) {
  channel {
    createChannel(input: $input) {
      channel {
        id
        currencies
        dateCreated
        dateModified
        externalId
        iconUrl
        isListableFromUi
        isVisible
        name
        platform
      }
    }
  }
}

Variables

{
  "input": {
    "externalId": "example",
    "isListableFromUi": true,
    "isVisible": true,
    "name": "example",
    "platform": "example",
    "status": "ACTIVE",
    "type": "example"
  }
}

Example response

{
  "data": {
    "channel": {
      "createChannel": {
        "channel": {
          "id": "example",
          "currencies": {
            "defaultCurrencyCode": null,
            "enabledCurrencyCodes": null
          },
          "dateCreated": "2026-10-30T22:30:43.002Z",
          "dateModified": "2026-10-30T22:30:43.002Z",
          "externalId": "example",
          "iconUrl": "example",
          "isListableFromUi": true,
          "isVisible": true,
          "name": "example",
          "platform": "example"
        }
      }
    }
  }
}

Creates a channel.

Arguments

inputCreateChannelInputRequired

Returns

an optional CreateChannelResult

channelChannelOptional

The Channel that is created as a result of mutation.