curl --request PATCH \
--url https://api.blujay.io/v1/chats/{chat_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Project kickoff"
}
'{
"status": "success",
"data": {
"chat_id": "chat_abc123",
"operation": "group_name_update",
"status": "accepted",
"display_name": "Project kickoff"
},
"trace_id": "trc_8f2a1c0e4b7d",
"timestamp": "2026-10-14T21:00:00.000Z"
}Rename a group chat or set its photo
Changes one thing about an active iMessage group chat: its name (display_name) or its photo (group_chat_icon). Everyone in the group sees the change. Blujay returns 202 once your phone number has accepted it.
For the photo, upload a JPEG or PNG with POST /v1/attachments first, then send group_chat_icon: { "attachment_id": "att_..." }. Blujay reduces the image to the size iMessage uses. Send group_chat_icon: null to remove the photo. Read the current photo back from icon on GET /v1/chats/{chat_id}.
Send display_name or group_chat_icon, not both (400 VALIDATION_ERROR). You can’t clear a group name. If the chat isn’t an active iMessage group, you get 400 UNSUPPORTED_CHAT_OPERATION.
curl --request PATCH \
--url https://api.blujay.io/v1/chats/{chat_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Project kickoff"
}
'{
"status": "success",
"data": {
"chat_id": "chat_abc123",
"operation": "group_name_update",
"status": "accepted",
"display_name": "Project kickoff"
},
"trace_id": "trc_8f2a1c0e4b7d",
"timestamp": "2026-10-14T21:00:00.000Z"
}Authorizations
Your workspace API key, sent as Authorization: Bearer blu_.... Workspace admins can find it in the Blujay app under API.
An API key has full access to your workspace and works on every endpoint. There is no test mode: every key sends real messages and changes real data, so keep it secret and use it only from your server.
Each API key can make 600 read requests and 120 write requests per minute, plus 60 attachment requests per minute. Over a limit you get 429 RATE_LIMIT_EXCEEDED with Retry-After.
Reseller partner keys. A partner key acts for one of the partner's customers when the request names it in the Blujay-Workspace header (the customer's workspace_ ID). Without the header it reaches only /v1/partner/* and /v1/me. Each customer gets the limits above for each partner key, and all of a partner's requests together get ten times those limits; a 429 says which in error.details[0].scope (partner_customer or partner). A messaging key can read anything for a customer and change chats, messages, contacts, attachments and vCards; everything else needs an admin key (403 PARTNER_ROLE_FORBIDDEN). Paused or closing customers can be read but not changed (409 CUSTOMER_PAUSED or CUSTOMER_CLOSING). Any other workspace ID in the header returns 404 NOT_FOUND; using the header with any other credential returns 400 WORKSPACE_HEADER_NOT_ALLOWED.
Path Parameters
^chat_[A-Za-z0-9_-]+$"chat_abc123"
Body
- Option 1
- Option 2
One change to an active iMessage group chat. Send display_name or group_chat_icon, not both.
The new group name. It can't be empty; you can't clear a group name through the API.
1 - 100"Order 4821 support"
The new group photo as a declared upload (a JPEG or PNG from POST /v1/attachments), or null to remove the photo.
Show child attributes
Show child attributes
Response
The change was accepted.
Wraps every successful response. The result is in data.
success ^trc_[A-Za-z0-9_-]+$"trc_8f2a1c0e4b7d"
"2026-10-14T17:01:00.000Z"
Show child attributes
Show child attributes
Your X-Request-ID header value, echoed back when you send one. Not included on the send responses (POST /v1/chats and POST /v1/chats/{chat_id}/messages); keep your own mapping from your request ID to the returned message ID there.