Delete Group

Description

This API will allow you to delete a Group within Hi Marley by Group ID.

Service Name	Delete Group
Service Type	REST
Method	DELETE
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/groups/:groupId
Production URL	https://integration.himarley.io/api/groups/:groupId
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
• API Response
• Common Errors to Handle

API Request

Flow

1. Send API request with the group ID to be deleted in the path.
2. Hi Marley receives the request and checks if the group ID passed exists for the org.
3. Hi Marley deletes the group & responds with a 204 no content success status.

Request Example

https://integration.uat.marley.ai/api/groups/83c4adef-26c5-4fb7-9686-353e087a667a

 

Request Path Breakdown

Property	Description	Type	Required	Example
groupId	The identifier generated and assigned to the Group.	string	true	"id": "05bec2c8-b243-4e88-bd20-80bebf66f5fa"

 

API Response 

Response Example

HTTP/1.1 204 No Content

Common Errors to Handle

Requests on a Deleted Group

{
"code": "GroupNotUpdated",
"category": "GenericApiError",
"retryable": false,
"status": 400,
"detail": "group could not be updated - no active group found with the id 7094fb91-7334-4c92-a8a2-a4af186a41c2",
"path": "/groups/{groupId}",
"method": "PUT",
"requestId": "d98650e7-82ec-4ff1-9974-2084fd8013cd"
}
]
}