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 delete.
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/delete-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.