Upload a chat wallpaper

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

Upload an image and create a synchronized user 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 POST https://z.u1v.ru/api/v1/chat_wallpapers/upload \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'colors=[4280391411]' \
    --data-urlencode name=Office \
    --data-urlencode 'settings={"fit": "cover"}' \
    --data-urlencode source_theme_profile_id=1 \
    -F file=@wallpaper.png \
    -F 'colors=@[4280391411]' \
    -F name=@Office \
    -F 'settings=@{"fit":"cover"}' \
    -F source_theme_profile_id=@1

Parameters

colors (integer)[] optional

Example: [4280391411]

Optional packed fallback colors.

name string | null optional

Example: "Office"

Optional user-visible wallpaper name.

settings object optional

Example: {"fit": "cover"}

Image rendering 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

Upload a chat wallpaper

Usage examples

Parameters

Response

Example response(s)