Update a chat wallpaper

PATCH https://z.u1v.ru/api/v1/chat_wallpapers/{wallpaper_id}

Update mutable fields of a user-owned wallpaper.

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/550e8400-e29b-41d4-a716-446655440000 \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'colors=[4280391411]' \
    --data-urlencode kind=gradient \
    --data-urlencode name=Ocean \
    --data-urlencode 'settings={"angle": 90}' \
    --data-urlencode source_theme_profile_id=1

Parameters

wallpaper_id string required in path

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

Wallpaper UUID.

colors (integer)[] optional

Example: [4280391411]

Replacement packed color values.

kind string | null optional

Example: "gradient"

Replacement wallpaper implementation kind.

name string | null optional

Example: "Ocean"

Replacement user-visible wallpaper name.

settings object | null optional

Example: {"angle": 90}

Replacement kind-specific settings.

source_theme_profile_id integer | null optional

Example: 1

Replacement source theme profile identifier.

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

Update a chat wallpaper

Usage examples

Parameters

Response

Example response(s)