API referenceContacts
Archive a contact
Preview· P9
POST
Hides them from lists, stops automatic attachment, and frees room under the plan's limit.
Scope: contacts:write
header
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers 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 mode | As above, in test mode |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As 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 partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As 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:write
contact_id*stringMatch
^contact_[0-7][0-9a-hjkmnp-tv-z]{25}$application/json- body
version*integerFormat
int64Range
1 <= valuearchived*booleanThe contact.
application/json- response
id*ContactIdMatch
^contact_[0-7][0-9a-hjkmnp-tv-z]{25}$display_name*stringLength
length <= 160given_name?stringfamily_name?stringpreferred_name?stringhonorific?stringjob_title?stringstatus*stringValue in
"active""archived""merged""erased"lifecycle?stringsource?stringcompany?owner?phone?stringemail?stringidentities?array<>marketing?array<>The channels with live consent.
minor?booleanMarked under 18: no marketing consent can be taken.
first_seen_at?stringFormat
date-timelast_seen_at?stringFormat
date-timelast_activity_at?stringFormat
date-timemerged_from?stringThe record asked for, when it's since been merged into this one.
version*integerFormat
int64curl -X POST 'https://api.agoohq.com/v1/contacts/string/archive' \ -H 'Content-Type: application/json' \ -d '{ "version": 1, "archived": true}'{ "id": "string", "display_name": "string", "given_name": "string", "family_name": "string", "preferred_name": "string", "honorific": "string", "job_title": "string", "status": "active", "lifecycle": "string", "source": "string", "company": {}, "owner": {}, "phone": "string", "email": "string", "identities": [ {} ], "marketing": [ "email" ], "minor": true, "first_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "last_activity_at": "2019-08-24T14:15:22Z", "merged_from": "string", "version": 0}