Skip to main content
PATCH
Update Channel Member

Autorizaciones

Authorization
string
header
requerido

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:read
dms:channel:manage
support_chat:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

Public resource ID.

Cuerpo

application/json
notification_preference
enum<string>
requerido
Opciones disponibles:
all,
mentions,
none
Ejemplo:

"mentions"

Respuesta

operation completed

channel_id
string
requerido
Ejemplo:

"feed_xxxxxxxxxxxxxxxxxxxxxx"

created_at
string | null
requerido

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

Ejemplo:

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

id
string | null
requerido

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

Ejemplo:

"memb_1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

inbox_status
enum<string> | null
requerido

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

Opciones disponibles:
requested,
accepted,
hidden,
null
Ejemplo:

"accepted"

last_viewed_at
string | null
requerido

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

Ejemplo:

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

notification_preference
enum<string> | null
requerido
Opciones disponibles:
all,
mentions,
none,
null
Ejemplo:

"all"

pinned_position
integer | null
requerido
Ejemplo:

null

unread
boolean | null
requerido

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

Ejemplo:

false

updated_at
string | null
requerido

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

Ejemplo:

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

user
object
requerido
user_id
string
requerido

User ID

Ejemplo:

"user_xxxxxxxxxxxxxx"