Skip to content
XOS Developers

Delete a pool member

Opportunities module

DELETE/pool-members/{id}poolMembers.delete

A pool member. Do Not Engage needs a reason and a review date and is never visible externally. Soft-deletes the pool member: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

poolMembers.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the pool member.

Response 204: no body.

Code samples

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