Rivier/ Reference/ contacts

Erase a person

post/crm/erase/{id}

Erase a person: record, history, notes and tasks go; their address stays suppressed as a one-way hash.

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:admin
Sdk
contacts.person.erase
Cli
contacts person erase
Events
contacts.person.erased

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • confirmstring (uuid)required

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown