Edit Group API

This API is designed to update existing groups on the Alohaa platform and facilitates modifications to group details such as name, description, members, and the group's unique identification.

Endpoint Description

POST https://priority-route.alohaa.ai/v1/external/group

Parameters

Request Headers

Field	Value	Description	Mandatory
Content-Type	application/json	Specifies the content type of the request.	Yes
x-metro-api-key	*************************	API key for authentication purposes.	Yes

Request Body

Field	Data Type	Description	Mandatory
name	String	The name of the group to be created.	Yes
description	String	A brief description of the group.	Yes
member	Array	An array of member phone numbers.	Yes
group_id	String	The unique identifier of the group to edit.	Yes

Sample Request

Request Header

{
  "x-metro-api-key": "****************"
}

Request Body

{
  "name": "Group 2",
  "description": "Tech Group",
  "members": ["9052931111", "9052932222", "9052934444"],
  "group_id": "61bc4453c59e4b22412c3d91"
}

Responses

Success Response

{
  "success": true,
  "response": {
    "group_id": "61bc4453c59e4b22412c3d91"
  }
}

Failure Response

{
  "success": false,
  "error": {
    "code": 1099,
    "reason": "Invalid schema or Missing Data sent"
  }
}

Error Codes

Code	Description
1006	Agent does not exist
1013	Organisation does not exist
1099	Invalid schema or Missing Data sent