Skip to main content
DELETE
/
v1
/
groups
/
{id}
/
members
/
{participantId}
Remove a member from a group
curl --request DELETE \
  --url https://api.scrip.dev/v1/groups/{id}/members/{participantId} \
  --header 'X-API-Key: <api-key>'
{
  "code": "bad_request",
  "details": {
    "expected": "present",
    "field": "amount",
    "message": "This field is required",
    "reason": "required",
    "received": "<string>"
  },
  "message": "Invalid request parameters"
}
Removes a participant from a group. This is a soft delete: the member’s status changes to LEFT, and they no longer appear in the default member listing. The member record is preserved for audit purposes. Removing a member does not affect the group’s balance or any transactions already associated with the group. The last ADMIN of a group cannot be removed. If you need to remove the final admin, first promote another member to ADMIN.
For usage patterns and examples, see the Groups guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
id
string<uuid>
required

Group ID

​
participantId
string<uuid>
required

Participant ID

Response

Member removed