Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Delete contact

DELETE /api/v2/contacts/:contact_uuid - Soft-deletes a contact (moves to trash).

DELETE/api/v2/contacts/:contact_uuid

Soft-deletes a contact (moves to trash).

Required scope: contacts (or *).

Path parameters

NameRequiredDescription
contact_uuidYesContact UUID
 
curl -s -X DELETE -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/contacts/c0a80101-0000-4000-8000-000000000001"
{ "success": true, "deleted": true }

See Errors for the standard error envelope and rate limits.