Attach a host to a channel

PUT /channels/{channelId}/hosts/{hostname}

Attach a host to a channel — a subdomain the organization owns that its customers reach the channel on (a portal's own domain, shop.ridgeline.com): Manifold's edge registers it as one of the organization's customer hosts (GET /settings/customer-host shows where it stands) and, once it serves, the documents of the channel's orders are linked on it.

Only the app providing the channel attaches, under its own token, while the channel is connected: 403 ChannelNotYours for a person's token or another app's; 404 ChannelNotFound; 409 ChannelNotConnected; 409 ChannelHostTaken when another of the organization's channels attaches the host; 409 ChannelHostsFull past ten hosts. Appends inventory.channel-host-attached. Idempotent by state: a host the channel already attaches is acknowledged and appends nothing.

Access

Requires integrations:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by state: a host the channel already attaches is acknowledged and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

inventory.channel-host-attached

What a fact is: Facts and the journal.

AI agent tool

No agent tool. Called by the app that provides the channel when the merchant gives it a domain of theirs, under the app's own token — the endpoint refuses any other caller; an agent reads a channel's hosts with inventory_get_channel.

Connecting an agent: AI agents.

Example

The portal's app attaches the merchant's own domain to its channel.

curl

curl -X PUT 'https://inventory.getmanifold.io/channels/chn_019ce0d8-5d50-7597-8115-9ea4c1b646da/hosts/shop.tidewater-supply.example' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://inventory.getmanifold.io/channels/chn_019ce0d8-5d50-7597-8115-9ea4c1b646da/hosts/shop.tidewater-supply.example", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "id": "chn_019ce0d8-5d50-7597-8115-9ea4c1b646da",
  "appId": "app_019b8b74-1800-79fd-be5b-3df405745c4d",
  "type": "webstore",
  "externalId": "tidewater-supply.example",
  "name": "Tidewater online store",
  "status": "connected",
  "catalogs": [
    {
      "catalogId": "cat_019cadd3-8524-7934-9ee3-29b896f71f80",
      "externalId": "online-store",
      "externalName": "Online Store"
    }
  ],
  "orderUrl": "https://tidewater-supply.example/admin/orders/{externalId}",
  "settingsPath": "/settings/channels/webstore",
  "currency": "AUD",
  "pricesIncludeTax": true,
  "payments": "channel",
  "connectedAt": "2026-03-12T07:00:02.000Z",
  "createdAt": "2026-03-12T07:00:02.000Z",
  "updatedAt": "2026-10-22T09:00:00.000Z",
  "hosts": [
    {
      "hostname": "shop.tidewater-supply.example",
      "attachedAt": "2026-10-22T09:00:00.000Z"
    }
  ]
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`ChannelNotYours` channelId, reason	This channel belongs to another app.	Call it with the app that provides the channel.
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`404`

Refusal	What it means	What to do
`ChannelNotFound` channelId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`ChannelNotConnected` channelId	The sales channel is disconnected.	Reconnect the channel first.
`ChannelHostTaken` channelId, hostname	Another of the organization's channels attaches the host.	Nothing changed. Read the record, then decide.
`ChannelHostsFull` channelId, max	The request was refused, and nothing changed.	Nothing changed. Read the record, then decide.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.