Create Group API

This API enables to establish groups on the Alohaa platform which consists of multiple agents.

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

Sample Request

Request Header

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

Request Body

{
  "name": "Group 1",
  "description": "Sales Group",
  "members": ["9052931111", "9052932222", "9052934444"]
}

Responses

Success Response

{
  "success": true,
  "response": {
    "virtual_no": "918069131110",
    "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