Download Manual Download

Navigation Mobile menu

Update a Channel

Overview

This end point allows you to update properties on an existing broadcast channel.

Request URL

All parameters in the request must be sent as a POST HTTP request. Make all requests to the following URL:

https://broadcasts.construct.net/updatechannel.json

Authenticating The Request

This end point is for secret key authenticated requests only. Signed in players cannot call this end point.

secret string Required: Your games secret API key.

Request Parameters

gameID guid Required: The ID of the game you are making this request against. You can find the ID of your game in your Construct Game Services (CGS) account.
channelID guid Required: The ID of the channel you want to to update.
name string: Provide this parameter to update the channels name, or exclude it to keep the existing channel name. Must be at least 1 character long and no more than 64 characters long. Channel names do not need to be unique. You must specify at least one of this, description, allowRatings or language.
description string: Provide this parameter to update the channels description, or exclude it to keep the existing description. Cannot exceed more than 256 characters long. You must specify at least one of this, name, allowRatings or language.
allowRatings bool: Provide this parameter to update if this channel allows ratings for messages, or exclude it to keep the current setting. You must specify at least one of this, name, description or language.
language string: Provide this parameter to update the language that the name and description of this channel are written in. Permitted values are AR, BG, CS, DA, DE, EL, EN, ES, ET, FI, FR, HE, HU, ID, IT, JA, KO, LT, LV, NB, NL, PL, PT, RO, RU, SK, SL, SV, TH, TR, UK, VI, ZH. You must specify at least one of this, name, description or allowRatings.

Success Response

Successful responses always return a HTTP 200 status code.

{
  "success": true,
  "formattingCulture": "en-us",
  "responseLanguage": {
    "iso": "EN",
    "englishName": "English"
  }
}

Response Properties

success bool: If the request was successfull or not.
formattingCulture string: If some return values are culture specific, this property indicates what culture the values have been rendered as.
responseLanguage Language: The language of translatable elements in the response. If this is different to the requested language, then it is likely your plan has run out of translation credits.

Failure Response

Unsuccessful responses always return HTTP 4xx status codes.

{
  "success": false,
  "errorMessage": "Your request failed due to...",
  "helpURL": "https://www.construct.net/en/game-services/manuals/game-services/broadcasts/api-end-points/channels/update-channel",
  "shouldRetry": false
}

Response Properties

success bool: If the request was successfull or not.
errorMessage string: An error message with more detailed information on why the request failed.
helpURL url (string): A link to documentation which should provide help with the error.
shouldRetry bool: Should the client wait a short period of time and retry the request. Usually this is false, but returns true if the request failed due to rate limiting.