Delete Membership

DELETE https://api.speakap.io/networks/:eid/memberships/:eid/

Use cases

  • Remove user from a group
  • Remove user from a network

Request

URI:/networks/{networkEID}/memberships/{membershipEID}/
Method:DELETE
Authentication:OAuth 2.0

Parameters

Name Type Description
networkEID EID Network EID
membershipEID EID Membership EID

Query Parameters

Name Type Value
force boolean Whether the removal of the membership should be forced (default: false). If the removal is not forced, the request may be rejected with the Stray User Prevented error code when trying to remove an external user from his or her last group.
resolution string Either remove_from_group (the default) or remove_from_network. This parameter should only be used in combination with force=true and removal from the network will be rejected with a No Stray User error when the removal of the the group membership would not have resulted in a stray user.

Response

202
Accepted for deletion: returns a Feedback object
403
Unauthorized: returns an Error object
404
Unknown network or membership: returns an Error object
409
User is not a member: returns an Error object

See also

Leave Group