Skip to content
XOS Developers

Delete an account membership

Identity module

DELETE/account-memberships/{id}accountMemberships.delete

A person in an external organization's account. Soft-deletes the account membership: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability me.account.write.
  • OAuth scopes: me.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

accountMemberships.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the account membership.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/account-memberships/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.accountMemberships.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.account_memberships.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos account-memberships delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f