channelId

string

expiresAfter?

number

(Optional) The duration in seconds after which the pinned message will be automatically unpinned. If neither expiresAfter nor expiresAt is provided, the message will remain pinned indefinitely. Providing both expiresAfter and expiresAt will result in a validation error.

expiresAt?

string

(Optional) The specific date and time (in ISO 8601 format) when the pinned message will be automatically unpinned. If neither expiresAfter nor expiresAt is provided, the message will remain pinned indefinitely. Providing both expiresAfter and expiresAt will result in a validation error.

messageId

string

The unique identifier of the message which should be pinned.

silent?

boolean

(Optional) Set to true to suppress system messages generated by this operation. Defaults to false.

userId?

string

(Optional) The unique identifier of the user when a service token is used.