Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB
Channels

Update a channel by ID

This endpoint updates the channel with the specified ID.

put/channels/{id}

Path parameters

idstring required

The channel ID.

Headers

Authorizationstring required

An OAuth2 authorization header with an access token, see OAuth2.

Request body

namestring required

The name of the channel.

addressstring

The address that is associated with the channel.

urlstring

A URL that to a website that the channel represents.

logoUrlstring

A URL to the channel logo.

localestring locale

The locale that is associated with the channel.

Example request

{
  "name": "my_example_channel",
  "address": "Anystr. 17, 12345, Anycity, Anystate 12345",
  "url": "https://wwww.myshop.fiction",
  "logoUrl": "https://wwww.myshop.fiction/logo.png",
  "locale": "en_US"
}

Response

The ID of the updated channel.

idstring

The unique identifier for this channel object.