Update Group

Important Note

This feature is available in the Business plan. If you haven't upgraded yet, please upgrade before using this feature.

API Overview

• Function: Update Group
• Request Method: POST
• Request URL: /api/contacts/teams/{team_id}/groups/{group_id}?appid={appid}&access_token={access_token}

Request Parameters

Parameter Name	Type	Required	Location	Description	Example
team_id	integer	Yes	uri	Team ID	30
group_id	integer	Yes	uri	Group ID	30
name	string	Yes	body	Group Name	Test Group
order	integer	No	body	Sort Order	1
from_id	integer	No	body	Original Parent Group ID	1
to_id	integer	No	body	New Parent Group ID (used when moving group)	1

Response Parameters

None

Response Examples

• Successful Request

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {},
    "request_id": "e9ab73bf-6a50-406f-8b19-7af5eb9e916c"
}

• Failed Request

{
    "code": "NotFound",
    "error": {
        "type": "contacts_group_not_found"
    },
    "data": {},
    "request_id": "e82ce6af-3256-4805-aca6-b86c19d6c334"
}

Error Codes

error.type Code	Description
invalid_argument	Parameter Validation Failed
claim_error	No Permission
contacts_team_not_found	Team Not Found
contacts_group_not_found	Group Not Found
group_too_deep	Group Hierarchy Too Deep
parent_group_not_found	Parent Group Not Found
default_group_be_modified	Default Group Cannot Be Modified
duplicated_remote_id	Duplicate Remote ID