Set chat background
Set or update the background image for a conversation. Works for both 1-on-1 and group chats.
The uploaded image is converted into a PosterKit-compatible archive and applied to the iMessage conversation on the linked device. Supported formats: JPEG, PNG, GIF, WebP, HEIC/HEIF. Maximum file size: 10 MB.
Authorization
BearerAuth API key authentication. Use your API key as the bearer token.
In: header
Path Parameters
Chat identifier. Can be: (1) phone number in E.164 format (e.g., +15551234567), (2) email address, (3) group ID (grp_xxxx), or (4) comma-separated list of phone numbers/emails for multi-recipient group chats (e.g., +15551234567,+15559876543). All values should be URL-encoded.
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
The image file to set as the chat background
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://backend.blooio.com/v2/api/chats/%2B15551234567/background" \ -F background="string"{
"chat_id": "string",
"has_background": true,
"background_id": "string",
"background_version": 0,
"changed": true
}{
"error": "string",
"status": 0
}{
"error": "string",
"status": 0
}{
"error": "string",
"status": 0
}{
"error": "string",
"status": 0
}