Set a conversation chat wallpaper

PATCH https://z.u1v.ru/api/v1/chat_wallpapers/conversation

Set or clear a wallpaper override for one conversation.

Usage examples

curl

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX PATCH https://z.u1v.ru/api/v1/chat_wallpapers/conversation \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode conversation_key=stream:42:topic:release \
    --data-urlencode wallpaper_id=550e8400-e29b-41d4-a716-446655440000

Parameters

conversation_key string required

Example: "stream:42:topic:release"

Stable key identifying the conversation.

wallpaper_id string | null optional

Example: "550e8400-e29b-41d4-a716-446655440000"

Wallpaper UUID, or an empty value to clear the override.

Response

Example response(s)

Successful response from a UCS extension endpoint. Endpoint-specific fields are returned alongside the standard Zulip success envelope.

{
    "msg": "",
    "result": "success"
}

API documentation home

Messages

Scheduled messages

Message reminders

Drafts

Navigation views

Channels

Users

Invitations

Server & organizations

Real-time events

Interactive bots

Specialty endpoints

Back to Zulip

Set a conversation chat wallpaper

Usage examples

Parameters

Response

Example response(s)