Channels

List

GET https://threads.com/api/public/channels

List the channels visible to your Bot user. These include public channels in your organization.

Headers

Name	Type	Description
Authorization	string	Bearer <your_api_key>
Content-Type	string	application/json

200: OK

401: Unauthorized

Example Request

curl \
  -H "Authorization: Bearer ABcD-ur5d6WK5lWZFKF3cKwp" \
  -H "Content-Type: application/json" \
  -X GET https://threads.com/api/public/channels

Example Response

{
    "ok": true,
    "result":
    [
        {
            "channelID": "32440334470",
            "name": "general-updates",
            "description": "Broad based updates for the company.",
            "privacy": "public",
            "memberIDs":
            [
                "32454348425",
                "32454344821",
                "32454484427"
            ]
        },
        {
            "channelID": "32460534446",
            "name": "random",
            "description": "A catch-all for all questions within the company.",
            "privacy": "public",
            "memberIDs":
            [
                "32454348425",
                "32454344821",
                "32454484427"
            ]
        },
        {
            "channelID": "32467534591",
            "name": "prviate",
            "description": "A place for third party integrations",
            "privacy": "prviate",
            "memberIDs":
            [
                "32454348425",
                "32454344824"
            ]
        }
    ]
}

Create

POST https://threads.com/api/public/createChannel

Create a new channel

Headers

Name	Type	Description
Authorization	string	Bearer <your_api_key>
Content-Type	string	application/json

Request Body

Name	Type	Description
name	string	name of the channel
userIDs	string []	an userIDs of emails to add to the channel
emails	string[]	an array of emails to add to the channel
description	string	a short description of what this channel will be used for

200: OK

401: Unauthorized

400: Bad Request

Example Request

curl \
  -H "Authorization: Bearer ABcD-ur5d6WK5lWZFKF3cKwp" \
  -H "Content-Type: application/json" \
  -X POST https://threads.com/api/public/createChannel \
  -d '{"name":"new channel", "description":"a new channel", "emails":["[e-mail]"], "userIDs": ["32454344821"]}'

Example Response

  {
      "ok": true,
      "result":
      {
          "channelID": "32391844586",
          "channelURL": "https://threads.com/32391844586"
      }
  }

Add members

POST https://threads.com/api/public/addChannelMembers

Add members to a channel

Headers

Name	Type	Description
Authorization	string	Bearer <your_api_key>
Content-Type	string	application/json

Request Body

Name	Type	Description
channelID	string	id of the channel
userIDs	string []	an userIDs of emails to add to the channel
emails	string[]	an array of emails to add to the channel

200: OK

401: Unauthorized

400: Bad Request

Example Request

curl \
  -H "Authorization: Bearer ABcD-ur5d6WK5lWZFKF3cKwp" \
  -H "Content-Type: application/json" \
  -X POST https://threads.com/api/public/addChannelMembers \
  -d '{"channelID":"32391844586", "emails":["[e-mail]"], "userIDs": ["32454344821"]}'

Example Response

{
    "ok": true
}

Delete

POST https://threads.com/api/public/deleteChannel

Delete a channel. Pass in the channelID.

Headers

Name	Type	Description
Authorization	string	Bearer <your_api_key>
Content-Type	string	application/json

Request Body

Name	Type	Description
channelID	string	This is ID of the channel you want to delete

200: OK

401: Unauthorized

400: Bad Request

Example Request

curl -i \
  -H "Authorization: Bearer ABcD-ur5d6WK5lWZFKF3cKwp" \
  -H "Content-Type: application/json" \
  -X POST https://threads.com/api/public/deleteChannel \
  -d '{"channelID":"32467534591"}'

Example Response

{
    "ok": true
}