API - Delete Members

POST https://gaggle.email/api/v2/delete-members

Delete members to an existing group.

Request

Parameters

api_key (string) Your API key (see API Introduction)
group_address (string)
The @gaggle.email address of the group
email (list) List of member email addresses to delete.  See example.

Example

This example shows deleting two members from the group.

POST https://gaggle.email/api/v2/delete-members
{
	'api_key': <your-api-key>,
	'group_address': 'test-group@gaggle.email',
	'email': [
		'new-member-1@acme.com',
		'new-member-2@acme.com',
	]
}

Response 

Status code 200 signifies success.

status (string) success: all members successfully deleted
failed: no members delete
message (string) optional error message
{ 	
	'status': 'failed', 	
	'message': 'you are not an administrator of the group'	
}
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us