Update Channel

Updates display details for a channel.

Only name, address, emoji, color, description, timezone, and opening_hours can be changed.
Send the fields to update; omitted fields stay as they are. At least one of those fields is required.
Send null for emoji, color, or description to clear them.

emoji must be an emoji. description is at most 255 characters. address cannot be blank.
timezone is an IANA name such as America/New_York. Abbreviations such as PST are not accepted.
opening_hours updates business hours for the weekdays you send. Other weekdays stay as they are.
Each weekday requires weekday, state, opens_at, and closes_at.
weekday is Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday.
state is open or closed. A state of closed keeps that weekday closed.
opens_at and closes_at are 24-hour HH:MM, such as 09:00. 00:00 is midnight.
00:00 to 00:00 means open all day.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Channel ID

Body Params

Update Channel Params

Fields that can be updated on a channel. Send only the fields to change.
At least one of name, address, emoji, color, description, timezone, or opening_hours is required.
Send null for emoji, color, or description to clear them. Address cannot be blank.
timezone is an IANA name such as America/New_York. Abbreviations such as PST are not accepted.
opening_hours updates business hours for the weekdays you send. Other weekdays stay as they are.
Each weekday requires weekday, state, opens_at, and closes_at.
weekday is Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday.
state is open or closed. Times are 24-hour HH:MM, such as 09:00. 00:00 is midnight.
00:00 to 00:00 means open all day. A state of closed keeps that weekday closed.

string

Channel address. Cannot be blank.

string | null

Hex color for the channel. Send null to clear.

string | null

Channel description, at most 255 characters. Send null to clear.

string | null

Emoji shown for the channel. Send null to clear.

string

Channel name

opening_hours
array of objects

Business hours for the channel. Send only the weekdays to change; other weekdays stay as they are.
Each item requires weekday, state, opens_at, and closes_at.
weekday is Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday.
state is open or closed. A state of closed keeps that weekday closed.
opens_at and closes_at are 24-hour HH:MM, such as 09:00 or 17:30. 00:00 is midnight.
00:00 to 00:00 means open all day.

opening_hours
string
enum

IANA timezone identifier, such as America/New_York or Europe/Dublin. Abbreviations such as PST or EST are not accepted.

Responses

Callback
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json