Skip to main content
POST
Add Channel Member

Autorisaties

Authorization
string
header
vereist

An App API key, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

dms:message:manage
support_chat:message:create

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Voorbeeld:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Body

application/json
channel_id
string
vereist

The channel to add the user to.

Voorbeeld:

"feed_xxxxxxxxxxxxxxxxxxxxxx"

user_id
string
vereist

The user to add.

Voorbeeld:

"user_xxxxxxxxxxxxxx"

Respons

operation completed

channel_id
string
vereist
Voorbeeld:

"feed_xxxxxxxxxxxxxxxxxxxxxx"

created_at
string | null
vereist

When the stored channel membership was created, as an ISO 8601 timestamp. Null for users whose access does not have a stored membership.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

id
string | null
vereist

Stored membership ID, or null for access-derived users.

Voorbeeld:

"memb_1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

inbox_status
enum<string> | null
vereist

Your inbox state for a private channel. null for other users and other channel kinds.

Beschikbare opties:
requested,
accepted,
hidden,
null
Voorbeeld:

"accepted"

last_viewed_at
string | null
vereist

Authorized participant read position. Community positions are visible only to the user themselves.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

notification_preference
enum<string> | null
vereist
Beschikbare opties:
all,
mentions,
none,
null
Voorbeeld:

"all"

pinned_position
integer | null
vereist
Voorbeeld:

null

unread
boolean | null
vereist

Your unread state for the channel. null for other users.

Voorbeeld:

false

updated_at
string | null
vereist

When the stored channel membership last changed, as an ISO 8601 timestamp. Null for users whose access does not have a stored membership.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

user
object
vereist
user_id
string
vereist

User ID

Voorbeeld:

"user_xxxxxxxxxxxxxx"