Docs

Erase a contact

Preview· P9
POST
/contacts/{contact_id}/erase

Refused under a legal hold. It can't be undone, and an opt-out stays as a keyed hash.

Scope: contacts:erase

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it
agoo_ck_live_Check API key, live mode, for a Check API partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs above, answering only the published test values, never billed

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: contacts:erase

Path Parameters

contact_id*string
Match^contact_[0-7][0-9a-hjkmnp-tv-z]{25}$

Request Body

application/json
  1. body
reason?string
Lengthlength <= 500

Response Body

What was erased.

application/json
  1. response
[key: string]?any
curl -X POST 'https://api.agoohq.com/v1/contacts/string/erase' \  -H 'Content-Type: application/json' \  -d '{}'
{}