Skip to main content
POST
/
message-channels
cURL
curl --request POST \
  --url https://api.opal.dev/v1/message-channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "third_party_provider": "SLACK",
  "remote_id": "C03FJR97276"
}'
{
  "message_channel_id": "6670617d-e72a-47f5-a84c-693817ab4860",
  "third_party_provider": "SLACK",
  "remote_id": "C03FJR97276",
  "name": "api-team-audit-channel",
  "is_private": false
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The MessageChannel object to be created.

CreateMessageChannelInfo Object

Description

The CreateMessageChannelInfo object is used to describe the message channel object to be created.

​
third_party_provider
enum<string>
required

The third party provider of the message channel.

Available options:
SLACK
Example:

"SLACK"

​
remote_id
string
required

The remote ID of the message channel

Example:

"C03FJR97276"

Response

200 - application/json

The message channel that was created.

MessageChannel Object

Description

The MessageChannel object is used to represent a message channel.

Usage Example

Update a groups message channel from the UPDATE Groups endpoint.

​
message_channel_id
string<uuid>
required

The ID of the message channel.

Example:

"6670617d-e72a-47f5-a84c-693817ab4860"

​
third_party_provider
enum<string>

The third party provider of the message channel.

Available options:
SLACK
Example:

"SLACK"

​
remote_id
string

The remote ID of the message channel

Example:

"C03FJR97276"

​
name
string

The name of the message channel.

Example:

"api-team-audit-channel"

​
is_private
boolean

A bool representing whether or not the message channel is private.

Example:

false