Appearance

Join Channels ​

Endpoint ​

http
POST /unified/instant-messaging/channels/join
Integrations supported
  • Slack

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

channel
object

Channel to join

Supported in
  • Slack
id
string

Unique identifier of the channel

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

Unique identifier for the channel.

Supported in
  • Slack
name
string

Name of the channel.

Supported in
  • Slack
description
string

Description of the channel.

Supported in
  • Slack
organization
object

Organization to which the channel belongs.

id
string

Unique identifier for the organization.

name
string

Name of the organization.

workspace
object

Workspace to which the channel belongs.

id
string

Unique identifier for the workspace.

name
string

Name of the workspace.

group
object

Group to which the channel belongs.

id
string

Unique identifier for the group.

name
string

Name of the group.

type
string

Type of the channel.

All possible enum values:
  • channel
  • private_channel
  • dm
  • group_dm
Supported in
  • Slack
status
string

Status of the channel.

All possible enum values:
  • active
  • archived
Supported in
  • Slack
is_member
boolean

Is the current authed user or application is a member of the channel. This might not directly mean that the user or application can post messages on the channel.

Supported in
  • Slack
created_by
object
Supported in
  • Slack
id
string

Unique identifier for the member.

created_at
string · date-time

Date and time when the channel was created.

Supported in
  • Slack
updated_at
string · date-time

Date and time when the channel was last updated.

Supported in
  • Slack
remote_data
object

Raw data returned from the remote API call.