v3

latestOpenAPI 3.1.02026-08-087684214.2 KB

conversations

Set Chat Background

Set a custom wallpaper for the chat (iMessage only).

Customer sends image_url; we fetch (≤10MB, JPEG/PNG/GIF/WebP/HEIC), validate, and forward as multipart to the iMessage provider. Idempotent — re-setting replaces. Recipients on iOS < 18 fall back to the default silently.

post/v1/conversations/{conversation_id}/background

Path parameters

conversation_idstring required

Request body

image_urlstring required

HTTPS URL of the background image. JPEG/PNG/GIF/WebP/HEIC, max 10MB. Recipients on iOS < 18 see the default background; no error is raised.

Example request

{
  "image_url": "https://example.com/wallpaper.jpg"
}

Response

Successful Response

conversationIdstring required

channelstring required

hasBackgroundboolean required

backgroundIdstring nullable

backgroundVersioninteger nullable

changedboolean required