PUT
/
api
/
v1
/
channels
/
{channel_id}
Update Channel
curl --request PUT \
  --url https://api.jobsim.work/api/v1/channels/{channel_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "name": "<string>",
  "organization_id": "<string>",
  "_id": "<string>",
  "description": "<string>",
  "channel_type": "public",
  "created_by": "<string>",
  "members": [
    "<string>"
  ],
  "admins": [
    "<string>"
  ],
  "is_archived": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
channel_id
string
required

Body

application/json

The body is of type Updates · object.

Response

Successful Response

​
name
string
required
Required string length: 1 - 80
​
organization_id
string
required
​
_id
string | null
​
description
string | null
​
channel_type
enum<string>
default:public
Available options:
public,
private,
direct_message
​
created_by
string | null
​
members
string[]
​
admins
string[]
​
is_archived
boolean
default:false
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
metadata
Metadata · object