Delete Counterparty Group Member

DELETE /api/v1/Counterparties/groups/members

Description

This endpoint is used to remove a member from a counterparty group. It returns a GuidResponse object containing information about the status of the deletion.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• counterpartyId: string, required, the id of the counterparty from which the member is to be removed.

• groupId: string, required, the id of the group from which the member is to be removed.

Request Body:

• None

URL:

• DELETE: {{baseUrl API url}}/api/v1/Counterparties/groups/members?counterpartyId={counterpartyId}&groupId={groupId}

Response:

• A GuidResponse object containing information about the status of the deletion.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

DELETE /api/v1/Counterparties/groups/members?counterpartyId=1234567890&groupId=abc123

Response:

HTTP/1.1 200 OK
{
  "id": "1234567890",
  "status": "deleted"
}

Method: DELETE

/api/v1/Counterparties/groups/members?counterpartyId=<uuid>&groupId=<uuid>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
counterpartyId	<uuid>
groupId	<uuid>

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": "<uuid>"
}