> ## Documentation Index > Fetch the complete documentation index at: https://docs.blujay.io/llms.txt > Use this file to discover all available pages before exploring further. # Rename a group chat > Sets the name of an active iMessage group chat. Everyone in the group sees the new name. Blujay returns `202` once the change is accepted. You can't clear a group name, and the group icon can't be changed through the API yet. If the chat isn't an active iMessage group, you get `400 UNSUPPORTED_CHAT_OPERATION`. ## OpenAPI ````yaml /api-reference/openapi.yaml patch /v1/chats/{chat_id} openapi: 3.1.0 info: title: Blujay API version: 1.0.0 description: >- The Blujay API lets you send and receive iMessage, RCS and SMS messages from your Blujay phone numbers, manage contacts, and receive real-time webhooks. Every response uses the same JSON envelope and carries a `trace_id` you can share with support. Authenticate with your workspace API key. servers: - url: https://api.blujay.io description: Production security: - PublicApiKey: [] tags: - name: Auth description: Check which workspace and credential a request is using. - name: Chats description: >- Direct and group conversations between your Blujay numbers and your contacts. - name: Messages description: Send, read, edit, unsend and retry messages. - name: Phone Numbers description: >- Your Blujay numbers, whether each can send right now, and their live sending limits. - name: Capability description: >- Check whether a phone number can be reached by iMessage, RCS or SMS before you send. - name: Contacts description: Create, find, update, tag, assign and opt out contacts. - name: vCards description: >- Saved contact cards that you can send in a message. Recipients get a native contact card over iMessage, SMS or RCS. - name: Team Members description: People in your workspace you can assign contacts to. - name: Workflows description: Enroll contacts in workflows you start manually. - name: Attachments description: >- Upload files once and reuse them in messages, or download files from messages. - name: Webhooks description: Subscribe to events, inspect delivery attempts and verify signatures. paths: /v1/chats/{chat_id}: patch: tags: - Chats summary: Rename a group chat description: > Sets the name of an active iMessage group chat. Everyone in the group sees the new name. Blujay returns `202` once the change is accepted. You can't clear a group name, and the group icon can't be changed through the API yet. If the chat isn't an active iMessage group, you get `400 UNSUPPORTED_CHAT_OPERATION`. operationId: updatePublicChat parameters: - $ref: '#/components/parameters/ChatId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublicChatMetadataUpdateInput' examples: renameGroup: summary: Rename the group value: display_name: Project kickoff responses: '202': description: The rename was accepted. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object required: - data properties: data: $ref: '#/components/schemas/AcceptedChatMetadataMutation' examples: accepted: value: 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' '400': description: >- The request is invalid, the chat isn't an active iMessage group (`UNSUPPORTED_CHAT_OPERATION`), or it used a field the API doesn't support yet (`FEATURE_NOT_ENABLED`). headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': $ref: '#/components/responses/NotFound' '503': $ref: '#/components/responses/PhoneNumberUnavailable' security: - PublicApiKey: [] components: parameters: ChatId: name: chat_id in: path required: true schema: $ref: '#/components/schemas/ChatId' schemas: PublicChatMetadataUpdateInput: type: object additionalProperties: false description: >- Changes to a group chat. Only `display_name` is supported, for active iMessage group chats. properties: display_name: type: string examples: - Order 4821 support minLength: 1 maxLength: 100 description: >- The new group name. It can't be empty; you can't clear a group name through the API. required: - display_name SuccessEnvelope: type: object description: Wraps every successful response. The result is in `data`. required: - status - trace_id - timestamp properties: status: type: string enum: - success trace_id: $ref: '#/components/schemas/TraceId' timestamp: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time client_request_id: type: string description: >- Your `X-Request-ID` header value, echoed back when you send one. Not included on the send responses (`POST /v1/chats`, `POST /v1/chats/{chat_id}/messages`, `POST /v1/messages/{message_id}/retry`); keep your own mapping from your request ID to the returned message ID there. AcceptedChatMetadataMutation: type: object additionalProperties: false required: - chat_id - operation - status - display_name properties: chat_id: $ref: '#/components/schemas/ChatId' operation: type: string enum: - group_name_update status: const: accepted display_name: type: string examples: - Order 4821 support ErrorEnvelope: type: object description: >- Wraps every error response. Branch on `error.code`, and include `trace_id` when you contact support. required: - status - error - trace_id - timestamp properties: status: const: error error: $ref: '#/components/schemas/PublicError' trace_id: $ref: '#/components/schemas/TraceId' timestamp: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time client_request_id: type: string description: Your `X-Request-ID` header value, echoed back when you send one. ChatId: type: string examples: - chat_abc123 pattern: ^chat_[A-Za-z0-9_-]+$ TraceId: type: string examples: - trc_8f2a1c0e4b7d pattern: ^trc_[A-Za-z0-9_-]+$ PublicError: type: object required: - code - message - type - http_status - retryable - doc_url - details properties: code: type: string description: Stable, machine-readable error code. Branch on this value. examples: - RATE_LIMIT_EXCEEDED - QUEUE_UNAVAILABLE - FEATURE_NOT_ENABLED message: type: string description: Human-readable explanation. It can change, so don't parse it. type: type: string description: Broad error category. examples: - validation - auth - idempotency - rate_limit - queue - feature_gate http_status: type: integer description: The HTTP status code of the response. enum: - 400 - 401 - 403 - 404 - 409 - 413 - 415 - 422 - 429 - 500 - 502 - 503 retryable: type: boolean description: Whether sending the same request again later can succeed. doc_url: type: string format: uri description: Link to documentation for this error code. details: type: array description: >- Extra structured context, such as the fields that failed validation or the limit you hit. items: type: object additionalProperties: true retry_after: type: integer minimum: 1 description: >- Seconds to wait before retrying. Also sent as the `Retry-After` header. reset_at: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time description: When the limit you hit resets. headers: XTraceID: description: >- Unique ID for this request. It matches `trace_id` in the body. Include it when you contact Blujay support. schema: $ref: '#/components/schemas/TraceId' RetryAfter: description: Seconds to wait before retrying. schema: type: integer minimum: 1 responses: NotFound: description: The resource doesn't exist or isn't in your workspace. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' PhoneNumberUnavailable: description: >- The messaging network couldn't accept the request right now (`PHONE_NUMBER_UNAVAILABLE`). Nothing was changed. Retry after `Retry-After` seconds. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: phoneNumberUnavailable: value: status: error error: code: PHONE_NUMBER_UNAVAILABLE message: This service is temporarily unavailable type: phone_number http_status: 503 retryable: true doc_url: https://docs.blujay.io/errors/phone-number-unavailable details: [] retry_after: 30 trace_id: trc_8f2a1c0e4b7d timestamp: '2026-10-14T00:00:00.000Z' securitySchemes: PublicApiKey: type: http scheme: bearer bearerFormat: blu_... description: > 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`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.