Create a chat wallpaper

POST https://z.u1v.ru/api/v1/chat_wallpapers

Create a synchronized wallpaper owned by the authenticated user.

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 POST https://z.u1v.ru/api/v1/chat_wallpapers \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'colors=[4280391411]' \
    --data-urlencode kind=gradient \
    --data-urlencode name=Ocean \
    --data-urlencode 'settings={"angle": 45}' \
    --data-urlencode source_theme_profile_id=1

Parameters

colors (integer)[] optional

Example: [4280391411]

Optional packed color values used by the wallpaper.

kind string required

Example: "gradient"

Wallpaper implementation kind.

name string required

Example: "Ocean"

User-visible wallpaper name.

settings object optional

Example: {"angle": 45}

Kind-specific wallpaper settings.

source_theme_profile_id integer | null optional

Example: 1

Optional 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

Create a chat wallpaper

Usage examples

Parameters

Response

Example response(s)