Sup Channels API

Automate your Sup Channel.
More information: https://www.yousup.me/api
Contact Info: anshu@yousup.me
Version: 1.0.0
BasePath: /api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

  1. get /api/changeDesc
  2. get /api/changeName
  3. get /api/deleteChannel
  4. get /api/getChannelsByOwner
  5. get /api/pushMessage
Up
get /api/changeDesc
Description changes (apiChangeDescGet)
This endpoint changes the description of a channel.

Query parameters

username (required)
Query Parameter — Username of the channel owner.
key (required)
Query Parameter — Your API key
channelId (required)
Query Parameter — The ID of the channel that you wish to modify
newDesc (required)
Query Parameter — This channel's new description

Return type

array[Result]

Example data

Content-Type: application/json
[ {
  "statusCode" : 1,
  "status" : "Success"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success or failure

Up
get /api/changeName
Name changes (apiChangeNameGet)
This endpoint changes the name of a channel.

Query parameters

username (required)
Query Parameter — Username of the channel owner.
key (required)
Query Parameter — Your API key
channelId (required)
Query Parameter — The ID of the channel that you wish to modify
newName (required)
Query Parameter — This channel's new name

Return type

array[Result]

Example data

Content-Type: application/json
[ {
  "statusCode" : 1,
  "status" : "Success"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success or failure

Up
get /api/deleteChannel
Delete Channel (apiDeleteChannelGet)
This endpoint deletes a channel.

Query parameters

username (required)
Query Parameter — Username of the channel owner.
key (required)
Query Parameter — Your API key
channelId (required)
Query Parameter — The ID of the channel that you wish to delete

Return type

array[Result]

Example data

Content-Type: application/json
[ {
  "statusCode" : -1,
  "status" : "Unauthorized or user doesn't exist"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success or failure

Up
get /api/getChannelsByOwner
Get channels by owner (apiGetChannelsByOwnerGet)
This endpoint retrieves all channels by a user. You must use this API only to retrieve your channels. Trying to retrieve any other owner's channels will fail.

Query parameters

username (required)
Query Parameter — Username of the channel owner.
key (required)
Query Parameter — Your API key (You must be the channel owner)

Return type

array[Result2]

Example data

Content-Type: application/json
[ {
  "statusCode" : 1,
  "status" : "Success",
  "results":[]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Status and list of channels that match owner

Up
get /api/pushMessage
Push Message (apiPushMessageGet)
This endpoint pushes a broadcast on behalf of a channel.

Query parameters

username (required)
Query Parameter — Username of the channel owner.
key (required)
Query Parameter — Your API key
channelId (required)
Query Parameter — The ID of the channel on whose behalf you wish to broadcast
message (required)
Query Parameter — The message that you wish to broadcast
link (optional)
Query Parameter — A link to a webpage that is opened when a user clicks the broadcast.

Return type

array[Result]

Example data

Content-Type: application/json
[ {
  "statusCode" : -1,
  "status" : "Unauthorized or user doesn't exist"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success or failure

Up

Models

[ Jump to Methods ]

Table of Contents

  1. Channel
  2. Result
  3. Result2

Channel Up

channelId
name
description
image
subscriberCount

Result Up

statusCode
Integer format: int32
status

Result2 Up

statusCode
Integer format: int32
status