Skip to content
XOS Developers

Delete a workforce group member

Workforce module

DELETE/group-members/{id}workforceGroupMembers.delete

A member of a group space. Deleting removes the member, who also leaves the group conversation. Soft-deletes the workforce group member: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

workforceGroupMembers.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the workforce group member.

Response 204: no body.

Code samples

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