Docs

Create a contact

Preview· P9
POST
/contacts

Held by the plan's contact limit. A phone or email already held is 409, and nothing merges silently. Numbers are read the way people write them.

Scope: contacts:write

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:write

Header Parameters

Idempotency-Key*string

A UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the original response instead of acting twice. While the first request is still running, a retry returns conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.

Formatuuid

Request Body

application/json
  1. body
display_name?string
Lengthlength <= 160
given_name?string
Lengthlength <= 80
family_name?string
Lengthlength <= 80
preferred_name?string
Lengthlength <= 80
honorific?string
Lengthlength <= 30
job_title?string
Lengthlength <= 120
company_id?string
company?string

A company's name: linked to one that exists, or a new one is made.

Lengthlength <= 200
owner_person_id?string
team_id?string
person_id?string
lifecycle?string
Lengthlength <= 40
language?string
minor?boolean
address?
phones?array<string>

As people write them. On create only.

Itemsitems <= 10
emails?array<string>
Itemsitems <= 10

Response Body

The contact.

application/json
  1. response
id*ContactId
Match^contact_[0-7][0-9a-hjkmnp-tv-z]{25}$
display_name*string
Lengthlength <= 160
given_name?string
family_name?string
preferred_name?string
honorific?string
job_title?string
status*string
Value in"active""archived""merged""erased"
lifecycle?string
source?string
company?
owner?
phone?string
email?string
identities?array<>
marketing?array<>

The channels with live consent.

minor?boolean

Marked under 18: no marketing consent can be taken.

first_seen_at?string
Formatdate-time
last_seen_at?string
Formatdate-time
last_activity_at?string
Formatdate-time
merged_from?string

The record asked for, when it's since been merged into this one.

version*integer
Formatint64
curl -X POST 'https://api.agoohq.com/v1/contacts' \  -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \  -H 'Content-Type: application/json' \  -d '{}'
{  "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}