Skip to main content

Delete 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: Delete Group
  • Request Method: POST
  • Request URL: /api/contacts/teams/{team_id}/groups/batch_delete?appid={appid}&access_token={access_token}

Request Parameters

Parameter NameTypeRequiredLocationDescriptionExample
team_idintegerYesuriTeam ID30
group_idsarray[integer]YesbodyGroup ID List[6008,6009]

Response Parameters

None

Request Example

{
"group_ids": [6008, 6009]
}

Response Examples

  • Successful Request
{
"code": "OK",
"error": {
"type": ""
},
"data": {},
"request_id": "5797836d-a88e-44ef-afd4-56b25d810214"
}
  • Failed Request
{
"code": "NotFound",
"error": {
"type": "contacts_group_not_found"
},
"data": {},
"request_id": "6cf30c83-a691-40af-b27c-c1dd9b3c9e80"
}

Error Codes

error.type CodeDescription
invalid_paramParameter Validation Failed
claim_errorNo Permission
contacts_group_not_foundData Not Found