All Products
Search

This Product

    Chat App Message Service:UpdateChatGroup

    Document Center

    Chat App Message Service:UpdateChatGroup

    Last Updated:Jul 01, 2026

    Modifies the information of an IM group.

    Operation description

    Important Modifying IM group information through API is a Meta beta feature. Contact your account manager to request allowlisting.

    • Creating WhatsApp groups through API is a Meta beta feature. Contact your account manager to request allowlisting.

    • Before calling this operation, make sure that you have an IM group that has been created.

    • If you do not have a created IM group, create one by calling the AddChatGroup operation.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cams:UpdateChatGroup

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BusinessNumber

    string

    Yes

    The business phone number. You can view the business phone number by calling the ListChatGroup operation.

    8613800***
    ChannelType

    string

    No

    The channel type. Valid values:

    • WHATSAPP.

    Note

    Only the WhatsApp channel type is supported.

    WHATSAPP
    CustSpaceId

    string

    Yes

    The space ID of the ISV sub-customer, which is also the instance ID. This is the channel ID, which can be viewed on the Channel Management page.

    cams-***
    GroupId

    string

    Yes

    The group ID. You can view the group ID by calling the ListChatGroup operation.

    EA303***
    Description

    string

    No

    The group description.

    test
    Subject

    string

    No

    The group subject.

    test title
    ProfilePictureFile

    string

    No

    The group profile picture.

    Note

    Image restrictions:

    • Supported MIME type: image/jpeg

    • Maximum image size: 5 MB

    • The image must be square with a minimum dimension of 192 × 192 pixels.

    https://*********/img.jpg

    Response elements

    Element

    Type

    Description

    Example

    object

    AccessDeniedDetail

    string

    The details about the access denial.

    None
    Message

    string

    The error message.

    None
    RequestId

    string

    The request ID.

    90E63D28-E31D-1EB2-8939-A94866411B2O

    Code

    string

    The response code. Valid values:

    • OK: The request was successful.

    • For other error codes, see Error codes.

    OK
    Success

    boolean

    Indicates whether the call was successful. Valid values:

    • true: The call was successful.

    • false: The call failed.

    false
    Result

    integer

    The number of affected rows.

    1

    Examples

    Success response

    JSON format

    {
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O\n",
  "Code": "OK",
  "Success": false,
  "Result": 1
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.