The Hive Inspect API is a work in progress. It is available to a small group of accounts today, and the release for everyone is coming very soon.
Authorizations
Authorization
string
header
required
Your API key from Business Tools → API Access.
Body
application/json
first_name
string
required
email
string<email>
required
last_name
string | null
cc_email
string | null
One or more CC email addresses, separated by commas (up to 10)
phone
string | null
business_name
string | null
agency_name
string | null
Agency name. A name that matches one of your agencies links the contact to it; any other name is kept as plain text. Prefer agency_id.
address
string | null
address_line2
string | null
city
string | null
state
string | null
zip
string | null
country
string | null
ISO-2, e.g. US or CA
birthday
string<date> | null
website
string | null
social
object | null
Show child attributes
notes
string | null
agency_id
string<uuid> | null
Link the contact to an agency from /v1/agencies. Takes precedence over agency_name.
uses_agency_address
boolean | null
true: use the agency's address for this contact. false: keep the contact's own address.
tag_ids
string<uuid>[] | null
Replace the contact's tags with these tag ids (see /v1/tags). An empty list removes every tag. Send tag_ids or tags, not both.
tags
string[] | null
Replace the contact's tags with these tag names (case-insensitive). The tags must already exist.
Response
Created
id
string<uuid>
first_name
string
last_name
string | null
email
string<email>
cc_email
string | null
One or more CC email addresses, separated by commas (up to 10)
phone
string | null
business_name
string | null
agency_name
string | null
address
string | null
address_line2
string | null
city
string | null
state
string | null
zip
string | null
country
string | null
ISO-2, e.g. US or CA
birthday
string<date> | null
website
string | null
social
object | null
Show child attributes
notes
string | null
tags
object[]
Show child attributes
roles
string[]
Distinct roles this contact has had on inspections
created_at
string<date-time>
updated_at
string<date-time>
photo_url
string | null
Signed link, valid for 1 hour
agency_id
string<uuid> | null
The agency (brokerage) this contact is linked to, from /v1/agencies. Null when agency_name is plain text.
uses_agency_address
boolean
true: the contact's address follows the agency's address
agency
object | null
The linked agency, when there is one
Show child attributes
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Hive Inspect","description":"Hive Inspect documentation: setup guides, how-tos, and product updates for the AI-powered home inspection software used by professional home inspectors.","colors":{"primary":"#0166c2","light":"#3496f0","dark":"#0b6cc9"},"logo":{"light":"https://mintcdn.com/hiveinspect-43c85ed1/ksh3AYooN6qduiUo/images/logo-light.png?fit=max\u0026auto=format\u0026n=ksh3AYooN6qduiUo\u0026q=85\u0026s=8f6b67a712bb44d172f8984ee41b347b","dark":"https://mintcdn.com/hiveinspect-43c85ed1/ksh3AYooN6qduiUo/images/logo-dark.png?fit=max\u0026auto=format\u0026n=ksh3AYooN6qduiUo\u0026q=85\u0026s=5c683dc6ab6224243079e62d40d6a8d5"},"favicon":"https://mintcdn.com/hiveinspect-43c85ed1/5oY9t9U2Yz0VU8mn/images/favicon.png?fit=max\u0026auto=format\u0026n=5oY9t9U2Yz0VU8mn\u0026q=85\u0026s=968e26fd124ca52d19751518395a029d","api":{"playground":{"display":"none"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#fcfcfd","dark":"#0f1217"}},"navbar":{"links":[{"href":"https://www.facebook.com/groups/1202950231646461","label":"Inspector community"},{"href":"https://www.hiveinspect.com","label":"Get 5 free reports"}],"primary":{"type":"button","label":"Open dashboard","href":"https://dashboard.hiveinspect.com"}},"footer":{"socials":{"instagram":"https://www.instagram.com/hive.inspect","facebook":"https://www.facebook.com/profile.php?id=61577925876518","youtube":"https://www.youtube.com/@hiveinspect","linkedin":"https://www.linkedin.com/company/hive-inspect"},"links":[{"header":"Get help","items":[{"label":"Inspector community on Facebook","href":"https://www.facebook.com/groups/1202950231646461"},{"label":"Ask in the chat bubble","href":"https://dashboard.hiveinspect.com"},{"label":"Request a feature","href":"https://dashboard.hiveinspect.com/dashboard/business-tools/feature-requests"}]},{"header":"Get the app","items":[{"label":"Hive Inspect on the App Store","href":"https://apps.apple.com/us/app/hive-inspect/id6737940474"},{"label":"Hive Inspect on Google Play","href":"https://play.google.com/store/apps/details?id=com.singaporv.estategpt"}]},{"header":"Hive Inspect","items":[{"label":"Pricing","href":"https://www.hiveinspect.com/pricing"},{"label":"Features","href":"https://www.hiveinspect.com/features"},{"label":"Compare","href":"https://www.hiveinspect.com/compare"}]},{"header":"Legal","items":[{"label":"Privacy policy","href":"https://www.hiveinspect.com/privacy"},{"label":"Terms of service","href":"https://www.hiveinspect.com/terms"},{"label":"Subscription agreement","href":"https://www.hiveinspect.com/subscription-agreement"},{"label":"SMS compliance","href":"https://www.hiveinspect.com/sms-compliance"},{"label":"EULA","href":"https://www.hiveinspect.com/eula"}]}]},"search":{"prompt":"Search, e.g. reschedule, TREC"},"seo":{"metatags":{"og:image":"https://docs.hiveinspect.com/images/og-cover.png","og:image:width":"1200","og:image:height":"630","og:image:alt":"Hive Inspect home inspection software on laptop, tablet, and phone","og:locale":"en_US","twitter:card":"summary_large_image","twitter:image":"https://docs.hiveinspect.com/images/og-cover.png","twitter:image:alt":"Hive Inspect home inspection software on laptop, tablet, and phone","author":"Hive Inspect","msvalidate.01":"72D895BDDEC4A34D44A2F5971922D98A","robots":"index, follow","googlebot":"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1"},"organization":{"id":"https://www.hiveinspect.com/#organization","name":"Hive Inspect","legalName":"Synapse Mobility, Inc.","url":"https://www.hiveinspect.com/","logo":"https://www.hiveinspect.com/images/shared/logo.png","sameAs":["https://www.hiveinspect.com/","https://apps.apple.com/us/app/hive-inspect/id6737940474","https://play.google.com/store/apps/details?id=com.singaporv.estategpt","https://www.instagram.com/hive.inspect/","https://www.facebook.com/profile.php?id=61577925876518","https://www.facebook.com/groups/1202950231646461","https://www.youtube.com/@hiveinspect","https://www.linkedin.com/company/hive-inspect"]},"indexing":"navigable"},"fonts":{"family":"Inter Tight"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"vesper"}},"latex":false},"integrations":{"ga4":{"measurementId":"G-7GHP7C1MB3"}},"errors":{"404":{"redirect":false,"title":"That page isn't here","description":"Try the search bar, start from [Set up Hive in order](/onboarding/onboarding-overview), or open [Fix a problem](/faq/fix-a-problem)."}},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hiveinspect-43c85ed1","hasAudioNarration":false,"actualSubdomain":"hiveinspect-43c85ed1","customDomains":["docs.hiveinspect.com"],"gitSource":{"type":"github","owner":"hive-inspect","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6afe0934a05c1b4750280be0","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"How-Tos","count":148},{"language":"default","tag":"How-to guides","count":121},{"language":"default","tag":"Videos","count":65},{"language":"default","tag":"What's new","count":48},{"language":"default","tag":"API","count":33},{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"FAQs","count":24},{"language":"default","tag":"All updates by date","count":24},{"language":"default","tag":"Getting Started","count":23},{"language":"default","tag":"Mobile App","count":22}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--color-primary-400: #3496f0;--color-primary-500: #0176df;--color-primary-600: #0166c2;--color-primary-700: #0153a0;--color-secondary: #1a1a1c;--hive-blue: var(--color-primary-600);--hive-blue-bright: var(--color-primary-500);--hive-blue-deep: var(--color-primary-700);--hive-blue-hover: var(--color-primary-700);--hive-focus: var(--color-primary-700);--hive-ink: var(--color-secondary);--hive-paper: #fcfcfd;--hive-rule: #dfe4eb;--hive-muted: rgba(26, 26, 28, 0.62);--hive-blue-tint: #e2eefb;--hive-shadow: 0 10px 20px -5px rgba(28, 34, 43, 0.05),\n 0 20px 65px -5px rgba(28, 34, 43, 0.05);--hive-radius: 12px}.dark{--hive-blue: var(--color-primary-400);--hive-blue-hover: #6bb6f8;--hive-focus: var(--color-primary-400);--hive-ink: #fcfcfc;--hive-paper: #0f1217;--hive-rule: #2a333e;--hive-muted: rgba(252, 252, 252, 0.6);--hive-blue-tint: #10304f;--hive-shadow: 0 10px 20px -5px rgba(0, 0, 0, 0.35),\n 0 20px 65px -5px rgba(0, 0, 0, 0.35)}body{-webkit-font-smoothing:antialiased}#page-title{font-size:clamp(1.625rem, 1.2rem + 1.6vw, 2rem);line-height:1.12;letter-spacing:-0.02em;font-weight:700}.mdx-content h2{font-size:1.5rem;line-height:1.2;letter-spacing:-0.01em;font-weight:600;margin-top:2.5rem}.mdx-content h3{font-size:1.125rem;line-height:1.33;font-weight:600}.mdx-content p,.mdx-content li{font-size:1rem;line-height:1.5}.eyebrow,.breadcrumb-item{text-transform:none;letter-spacing:0;font-weight:500}.dark .mdx-content a:hover{color:var(--hive-blue-hover)}.hive-ts{float:right;margin-top:-2.4rem;font-size:0.875rem;font-weight:500;font-variant-numeric:tabular-nums;color:var(--hive-blue);text-decoration:underline;text-underline-offset:2px;border-bottom:0;padding:0.25rem 0.125rem}.hive-ts:hover{color:var(--hive-blue-hover)}@media (max-width: 639px){.hive-ts{float:none;display:inline-block;margin-top:-0.25rem;margin-bottom:0.5rem}}.hive-videocaption{display:flex;justify-content:space-between;gap:1rem;margin:0 0 0.5rem;font-size:0.8125rem;line-height:1.4;color:var(--hive-muted)}.hive-videocaption-time{font-variant-numeric:tabular-nums;flex:none}.mdx-content img:not([data-component-part=\"card-image\"]):not(.not-prose *):not([alt=\"\"]){border-radius:var(--hive-radius);box-shadow:var(--hive-shadow);outline:1px solid var(--hive-rule);outline-offset:-1px;background:#fff}.frame{border-radius:var(--hive-radius);box-shadow:var(--hive-shadow)}.frame img{box-shadow:none;outline:0}.hive-rows{margin:1rem 0 2rem;border-top:1px solid var(--hive-rule);border-bottom:1px solid var(--hive-rule)}.hive-rows>*+*{border-top:1px solid var(--hive-rule)}.hive-row{position:relative;display:flex;flex-wrap:wrap;align-items:baseline;column-gap:1rem;row-gap:0.25rem;padding:1rem 2rem 1rem 0;text-decoration:none;color:inherit;border-bottom:0}.hive-row-main{flex:1 1 100%;min-width:0}.hive-row-title{display:block;font-size:1.125rem;line-height:1.33;font-weight:600;letter-spacing:-0.01em;color:var(--hive-ink)}.hive-row:hover .hive-row-title{color:var(--hive-blue)}.hive-row-line{display:block;font-weight:400;margin-top:0.25rem;font-size:0.875rem;line-height:1.45;color:var(--hive-muted)}.hive-row-meta{flex:1 1 100%;order:3;display:flex;gap:1.25rem;font-size:0.875rem;font-weight:500;font-variant-numeric:tabular-nums;color:var(--hive-muted)}.hive-row::after{content:\"\";position:absolute;right:0.25rem;top:50%;width:0.5rem;height:0.5rem;margin-top:-0.3rem;border-right:2px solid var(--hive-blue);border-bottom:2px solid var(--hive-blue);transform:rotate(-45deg);transition:transform 0.15s ease, right 0.15s ease}.hive-row:hover::after{right:0.05rem}@media (min-width: 640px){.hive-row-main{flex:1 1 0}.hive-row-meta{flex:0 0 auto;order:0}}.hive-rows-sm .hive-row{padding-top:0.75rem;padding-bottom:0.75rem}.hive-rows-sm .hive-row-title{font-size:1rem}.hive-label{margin:2rem 0 0.25rem;font-size:0.875rem;font-weight:500;color:var(--hive-muted)}.hive-runtime{display:inline-flex;align-items:center}.hive-runtime::before{content:\"\";flex:none;width:0;height:0;margin-right:0.4rem;border-left:0.4rem solid currentColor;border-top:0.26rem solid transparent;border-bottom:0.26rem solid transparent}.hive-meta{display:flex;flex-wrap:wrap;gap:0.25rem 1.5rem;margin-bottom:0.25rem;font-size:0.875rem;font-variant-numeric:tabular-nums;color:var(--hive-muted)}.hive-locator{margin:0 0 1.5rem;font-size:0.875rem;color:var(--hive-muted)}.hive-locator strong{font-weight:600;color:var(--hive-ink)}.hive-field{position:relative;overflow:hidden;border-radius:var(--hive-radius);background:var(--hive-blue-bright);color:#fff;min-height:21rem}.hive-field-inner{position:relative;padding:2rem 1.5rem}@media (min-width: 640px){.hive-field-inner{padding:3rem 2.5rem}}@media (min-width: 1024px){.hive-field-inner{max-width:57%}}.hive-field-label{font-size:1rem;font-weight:600;color:#fff}.hive-field h1{margin:0.5rem 0 0;font-size:1.875rem;line-height:1.13;letter-spacing:-0.02em;font-weight:700;color:#fff}@media (min-width: 640px){.hive-field h1{font-size:2.5rem;line-height:1.1}}.hive-field-lede{display:none;margin-top:1rem;font-size:1.125rem;line-height:1.55;color:#fff}@media (min-width: 640px){.hive-field-lede{display:block}}.hive-field-mark{position:absolute;right:-4rem;top:-3.5rem;width:27rem;height:auto;opacity:0.12;pointer-events:none}@media (max-width: 639px){.hive-field-mark{right:-7rem;top:-4rem;width:20rem;opacity:0.09}}.hive-field-device{display:none}@media (min-width: 1024px){.hive-field-device{display:block;position:absolute;right:-1%;bottom:-7%;width:44%;height:auto;pointer-events:none}.hive-field-device img{width:100%;height:auto}}.hive-field-video{position:relative;padding:0 1.5rem 2rem}.hive-field-video figure{margin:0}.hive-field-video figure>div{box-shadow:0 0 0 2px rgba(255, 255, 255, 0.35), 0 12px 32px rgba(0, 0, 0, 0.25)}.hive-field-video-caption{margin:0.625rem 0 0;font-size:1rem;font-weight:600;color:#fff;text-align:center}@media (max-width: 1023px){.hive-field-inner:has(+.hive-field-video){padding-bottom:0}}@media (min-width: 640px){.hive-field-video{max-width:36rem;padding:0 2.5rem 3rem}}@media (min-width: 1024px){.hive-field-video{position:absolute;right:2.5rem;top:50%;transform:translateY(-50%);width:37%;max-width:none;padding:0}}.hive-field .hive-rows,.hive-field .hive-rows>*+*{border-color:rgba(255, 255, 255, 0.25)}.hive-field .hive-row-title,.hive-field .hive-row-line,.hive-field .hive-row-meta{color:#fff}.hive-field .hive-row-line{display:none}@media (min-width: 640px){.hive-field .hive-row-line{display:block;font-size:1rem}}.hive-field .hive-row-meta{font-size:1rem}.hive-field .hive-row::after{border-color:#fff}.hive-field .hive-row:hover .hive-row-title{color:#fff;text-decoration:underline;text-underline-offset:3px}.hive-home{max-width:none;margin:0;padding:1.5rem 1rem 4rem}@media (min-width: 640px){.hive-home{padding-left:1.5rem;padding-right:1.5rem}}.hive-home h2{margin-top:2.5rem;font-size:1.5rem;line-height:1.2;letter-spacing:-0.01em;font-weight:600}.hive-applinks{margin-top:-1rem;font-size:0.875rem}.hive-applinks a+a{margin-left:1.25rem}.hive-spine{display:flex;flex-direction:column;gap:0.5rem 1.5rem;margin:1rem 0 2rem;padding:0;list-style:none}@media (min-width: 640px){.hive-spine{flex-direction:row;flex-wrap:wrap;align-items:baseline}}.hive-spine li{margin:0}.hive-spine .hive-spine-num{margin-right:0.4rem;font-variant-numeric:tabular-nums;color:var(--hive-muted)}.card{border:0;border-bottom:1px solid var(--hive-rule);border-radius:0;box-shadow:none;background:transparent;padding:1rem 0}.card:hover{background:transparent}[data-component-part=\"card-title\"]{font-size:1.125rem;font-weight:600;letter-spacing:-0.01em}[data-component-part=\"card-icon\"]{display:none}.callout{border-radius:var(--hive-radius)}.accordion{border-color:var(--hive-rule)}.update{padding-bottom:1.5rem;border-bottom:1px solid var(--hive-rule)}img.nav-logo{height:26px!important;width:auto!important}#topbar-cta-button a>span[class*=\"absolute\"]{border-radius:9999px}#topbar-cta-button a{border-radius:9999px;overflow:hidden;font-weight:600}#sidebar-content li[data-active]>a{border-radius:9999px;font-weight:600}.sidebar-group-header{text-transform:none;font-size:0.8125rem;font-weight:600;letter-spacing:-0.01em;color:var(--hive-ink)}.nav-tag-pill{border-radius:9999px;font-weight:600}[data-component-part=\"pagination-title\"]{font-weight:600;letter-spacing:-0.01em}#footer a{max-width:none;white-space:normal;overflow:visible;text-overflow:clip;line-height:1.4}#footer a[href*=\"facebook.com/groups\"]{color:var(--hive-blue);font-weight:600}@media (min-width: 1024px){#body-content{padding-left:0;padding-right:0;max-width:none}#sidebar-content{padding-left:1rem}#content-container{padding-left:2rem;padding-right:1.5rem;max-width:none}}@media (min-width: 1280px){#content-area{max-width:none;margin-left:0;margin-right:auto}#content-area:has(.hive-home){max-width:none}.mdx-content>p,.mdx-content>ul,.mdx-content>ol{max-width:60rem}}@media (min-width: 1024px){#navbar>div:not([class*=\"absolute\"]){max-width:none;padding-left:1rem;padding-right:1.5rem}#navbar>div:not([class*=\"absolute\"]) div[class*=\"lg:px-4\"]{padding-left:0;padding-right:0}#footer>div{max-width:none;margin-left:0;margin-right:0;padding-left:2rem;padding-right:1.5rem}}@media (min-width: 1024px){#search-bar-entry{width:100%;max-width:44rem;height:2.5rem}}[data-component-part=\"step-indicator\"]{clip-path:polygon(100% 50%, 75% 93.3%, 25% 93.3%, 0 50%, 25% 6.7%, 75% 6.7%);background-color:var(--hive-blue-tint)!important;color:var(--hive-blue)!important;font-variant-numeric:tabular-nums;font-weight:600}.hive-spine .hive-spine-num{display:inline-flex;align-items:center;justify-content:center;width:1.5rem;height:1.5rem;clip-path:polygon(100% 50%, 75% 93.3%, 25% 93.3%, 0 50%, 25% 6.7%, 75% 6.7%);background-color:var(--hive-blue-tint);color:var(--hive-blue);font-size:0.8125rem;font-weight:600}.hive-dir{columns:1;column-gap:3rem;margin:0.5rem 0 3rem}@media (min-width: 768px){.hive-dir{columns:2}}@media (min-width: 1440px){.hive-dir{columns:3}}.hive-dir-section{break-inside:avoid;margin-bottom:2.25rem;padding-top:1.25rem;border-top:1px solid var(--hive-rule)}.hive-dir-head{display:flex;align-items:center;gap:0.75rem;text-decoration:none;color:inherit;border-bottom:0}.hive-dir-num{flex:none;display:inline-flex;align-items:center;justify-content:center;width:1.75rem;height:1.75rem;clip-path:polygon(100% 50%, 75% 93.3%, 25% 93.3%, 0 50%, 25% 6.7%, 75% 6.7%);background-color:var(--hive-blue-tint);color:var(--hive-blue);font-size:0.8125rem;font-weight:600;font-variant-numeric:tabular-nums}.hive-dir-title{flex:1 1 auto;min-width:0;font-size:1.125rem;line-height:1.33;font-weight:600;letter-spacing:-0.01em;color:var(--hive-ink)}.hive-dir-head:hover .hive-dir-title{color:var(--hive-blue)}.hive-dir-count{flex:none;display:inline-flex;align-items:center;gap:0.6rem;font-size:0.8125rem;font-weight:500;font-variant-numeric:tabular-nums;color:var(--hive-muted)}.hive-dir-count::after{content:\"\";width:0.45rem;height:0.45rem;border-right:2px solid var(--hive-blue);border-bottom:2px solid var(--hive-blue);transform:rotate(-45deg);transition:transform 0.15s ease}.hive-dir-head:hover .hive-dir-count::after{transform:translateX(2px) rotate(-45deg)}.hive-dir-desc{margin:0.5rem 0 0.75rem;font-size:0.875rem;line-height:1.45;color:var(--hive-muted)}.hive-dir-list{margin:0;padding:0;list-style:none}.hive-dir-list li{margin:0;padding:0}.hive-dir-list a{display:block;padding:0.3125rem 0;font-size:0.9375rem;line-height:1.4;color:var(--hive-ink);text-decoration:none;border-bottom:0}.hive-dir-list a:hover{color:var(--hive-blue)}a:focus-visible,button:focus-visible,input:focus-visible,[role=\"button\"]:focus-visible,[tabindex]:focus-visible{outline:2px solid var(--hive-focus)!important;outline-offset:2px!important}.hive-field a:focus-visible,.hive-field button:focus-visible{outline-color:#fff!important}@media (prefers-reduced-motion: reduce){*,::before,::after{animation-duration:0.01ms!important;animation-iteration-count:1!important;transition-duration:0.01ms!important;scroll-behavior:auto!important}}"}]}
{"page":{"pagePath":"api/contacts/create-a-contact","slug":"/api/contacts/create-a-contact","pageMetadata":{"title":"Create a contact","description":null,"deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/contacts","href":"/api/contacts/create-a-contact","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`The Hive Inspect API is a work in progress.`}),` It is available to a small group of accounts today, and the release for everyone is coming very soon.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"vesper"}},"config":{},"pageMetadata":{"title":"Create a contact","description":null,"deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/contacts","href":"/api/contacts/create-a-contact","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createContact","summary":"Create a contact","tags":["Contacts"],"requestBody":"ead8f766-dc8b-4990-98e1-1b8f059b930d","responses":{"201":"da356960-a624-42e9-8a2e-07446f855b3d","400":"fe0bb2c8-a482-4983-a032-3dafe8085a91","401":"0330c676-0ee2-46b8-9e7d-ad532180a7c2","409":"264697f9-28e2-45c9-8b22-cb8bc720e324","422":"db89d7fe-7f49-4e0b-9207-6ca843836031","429":"193cb2a0-1462-4892-bb06-df3a3c753c89"},"x-mint":{"content":"\u003cNote>\n **The Hive Inspect API is a work in progress.** It is available to a small group of accounts today, and the release for everyone is coming very soon.\n\u003c/Note>"},"method":"post","type":"path","servers":["1c11b178-1dad-4dc1-8244-275954f6bbdf"],"security":["0d54c6f9-b00e-4cbe-9e35-3f31f5588c37"],"path":"/v1/contacts","baseUrlOptions":["https://api.hiveinspect.com"],"title":"Create a contact","description":"","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["first_name","email"],"properties":{"first_name":{"type":"string","isRequired":true,"uniqueKey":"first_name","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"cc_email":{"oneOf":[{"type":"string","description":"One or more CC email addresses, separated by commas (up to 10)","uniqueKey":"cc_email.oneOf.0","typeLabel":"string"},{"type":"null","description":"One or more CC email addresses, separated by commas (up to 10)","uniqueKey":"cc_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"cc_email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","uniqueKey":"business_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"business_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_name","typeLabel":"string | null"},"agency_name":{"oneOf":[{"type":"string","description":"Agency name. A name that matches one of your agencies links the contact to it; any other name is kept as plain text. Prefer agency_id.","uniqueKey":"agency_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Agency name. A name that matches one of your agencies links the contact to it; any other name is kept as plain text. Prefer agency_id.","uniqueKey":"agency_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency_name","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","uniqueKey":"address_line2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address_line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"city.oneOf.1","typeLabel":"null"}],"uniqueKey":"city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"state.oneOf.1","typeLabel":"null"}],"uniqueKey":"state","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","uniqueKey":"zip.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"zip","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"ISO-2, e.g. US or CA","uniqueKey":"country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO-2, e.g. US or CA","uniqueKey":"country.oneOf.1","typeLabel":"null"}],"uniqueKey":"country","typeLabel":"string | null"},"birthday":{"oneOf":[{"type":"string","format":"date","uniqueKey":"birthday.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"birthday.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthday","typeLabel":"string\u003cdate> | null"},"website":{"oneOf":[{"type":"string","uniqueKey":"website.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"website.oneOf.1","typeLabel":"null"}],"uniqueKey":"website","typeLabel":"string | null"},"social":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"social.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"social.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"social.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"social.oneOf.1","typeLabel":"null"}],"uniqueKey":"social","typeLabel":"object | null"},"notes":{"oneOf":[{"type":"string","uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"},"agency_id":{"oneOf":[{"type":"string","format":"uuid","description":"Link the contact to an agency from /v1/agencies. Takes precedence over agency_name.","uniqueKey":"agency_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Link the contact to an agency from /v1/agencies. Takes precedence over agency_name.","uniqueKey":"agency_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency_id","typeLabel":"string\u003cuuid> | null"},"uses_agency_address":{"oneOf":[{"type":"boolean","description":"true: use the agency's address for this contact. false: keep the contact's own address.","uniqueKey":"uses_agency_address.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"true: use the agency's address for this contact. false: keep the contact's own address.","uniqueKey":"uses_agency_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"uses_agency_address","typeLabel":"boolean | null"},"tag_ids":{"oneOf":[{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"tag_ids.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Replace the contact's tags with these tag ids (see /v1/tags). An empty list removes every tag. Send tag_ids or tags, not both.","uniqueKey":"tag_ids.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","items":{"type":"string","format":"uuid"},"description":"Replace the contact's tags with these tag ids (see /v1/tags). An empty list removes every tag. Send tag_ids or tags, not both.","uniqueKey":"tag_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"tag_ids","typeLabel":"string\u003cuuid>[] | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Replace the contact's tags with these tag names (case-insensitive). The tags must already exist.","uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Replace the contact's tags with these tag names (case-insensitive). The tags must already exist.","uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"}},"example":{"first_name":"Dana","last_name":"Reyes","email":"dana@example.com","phone":"(512) 555-0142","agency_id":"6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c","tags":["Top agent"]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"first_name":"Dana","last_name":"Reyes","email":"dana@example.com","phone":"(512) 555-0142","agency_id":"6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c","tags":["Top agent"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"da356960-a624-42e9-8a2e-07446f855b3d":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"first_name":{"type":"string","uniqueKey":"first_name","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"email":{"type":"string","format":"email","uniqueKey":"email","typeLabel":"string\u003cemail>"},"cc_email":{"oneOf":[{"type":"string","description":"One or more CC email addresses, separated by commas (up to 10)","uniqueKey":"cc_email.oneOf.0","typeLabel":"string"},{"type":"null","description":"One or more CC email addresses, separated by commas (up to 10)","uniqueKey":"cc_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"cc_email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","uniqueKey":"business_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"business_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_name","typeLabel":"string | null"},"agency_name":{"oneOf":[{"type":"string","uniqueKey":"agency_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"agency_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency_name","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","uniqueKey":"address_line2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address_line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"city.oneOf.1","typeLabel":"null"}],"uniqueKey":"city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"state.oneOf.1","typeLabel":"null"}],"uniqueKey":"state","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","uniqueKey":"zip.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"zip","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"ISO-2, e.g. US or CA","uniqueKey":"country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO-2, e.g. US or CA","uniqueKey":"country.oneOf.1","typeLabel":"null"}],"uniqueKey":"country","typeLabel":"string | null"},"birthday":{"oneOf":[{"type":"string","format":"date","uniqueKey":"birthday.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"birthday.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthday","typeLabel":"string\u003cdate> | null"},"website":{"oneOf":[{"type":"string","uniqueKey":"website.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"website.oneOf.1","typeLabel":"null"}],"uniqueKey":"website","typeLabel":"string | null"},"social":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"social.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"social.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"social.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"social.oneOf.1","typeLabel":"null"}],"uniqueKey":"social","typeLabel":"object | null"},"notes":{"oneOf":[{"type":"string","uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"tags.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"tags.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tags","typeLabel":"object[]"},"roles":{"type":"array","items":{"type":"string","uniqueKey":"roles.items.[INDEX]","typeLabel":"string"},"description":"Distinct roles this contact has had on inspections","uniqueKey":"roles","typeLabel":"string[]"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"photo_url":{"oneOf":[{"type":"string","description":"Signed link, valid for 1 hour","uniqueKey":"photo_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Signed link, valid for 1 hour","uniqueKey":"photo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"photo_url","typeLabel":"string | null"},"agency_id":{"oneOf":[{"type":"string","format":"uuid","description":"The agency (brokerage) this contact is linked to, from /v1/agencies. Null when agency_name is plain text.","uniqueKey":"agency_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The agency (brokerage) this contact is linked to, from /v1/agencies. Null when agency_name is plain text.","uniqueKey":"agency_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency_id","typeLabel":"string\u003cuuid> | null"},"uses_agency_address":{"type":"boolean","description":"true: the contact's address follows the agency's address","uniqueKey":"uses_agency_address","typeLabel":"boolean"},"agency":{"oneOf":[{"type":"object","description":"The linked agency, when there is one","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"agency.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","uniqueKey":"agency.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"agency.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency.oneOf.0.name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"agency.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"agency.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency.oneOf.0.phone","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","uniqueKey":"agency.oneOf.0.website.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"agency.oneOf.0.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency.oneOf.0.website","typeLabel":"string | null"}},"uniqueKey":"agency.oneOf.0","typeLabel":"object"},{"type":"null","description":"The linked agency, when there is one","uniqueKey":"agency.oneOf.1","typeLabel":"null"}],"uniqueKey":"agency","typeLabel":"object | null"}},"example":{"id":"0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f","first_name":"Dana","last_name":"Reyes","email":"dana@example.com","cc_email":null,"phone":"(512) 555-0142","business_name":null,"agency_name":"Lone Star Realty","agency_id":"6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c","agency":{"id":"6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c","name":"Lone Star Realty","phone":"(512) 555-0100","website":"https://lonestarrealty.example.com"},"uses_agency_address":true,"address":"410 Oak St","address_line2":null,"city":"Austin","state":"TX","zip":"78701","country":"US","birthday":"1988-04-12","website":null,"social":null,"notes":"Prefers text messages","photo_url":"https://files.example.com/signed-link-valid-for-1-hour","tags":[{"id":"5a1d9c3e-2b7f-4f0a-8c6d-1e2f3a4b5c6d","name":"Top agent"}],"roles":["Buyer Agent","Listing Agent"],"created_at":"2026-03-02T15:04:11Z","updated_at":"2026-09-18T20:41:07Z"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f","first_name":"Dana","last_name":"Reyes","email":"dana@example.com","cc_email":null,"phone":"(512) 555-0142","business_name":null,"agency_name":"Lone Star Realty","agency_id":"6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c","agency":{"id":"6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c","name":"Lone Star Realty","phone":"(512) 555-0100","website":"https://lonestarrealty.example.com"},"uses_agency_address":true,"address":"410 Oak St","address_line2":null,"city":"Austin","state":"TX","zip":"78701","country":"US","birthday":"1988-04-12","website":null,"social":null,"notes":"Prefers text messages","photo_url":"https://files.example.com/signed-link-valid-for-1-hour","tags":[{"id":"5a1d9c3e-2b7f-4f0a-8c6d-1e2f3a4b5c6d","name":"Top agent"}],"roles":["Buyer Agent","Listing Agent"],"created_at":"2026-03-02T15:04:11Z","updated_at":"2026-09-18T20:41:07Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"fe0bb2c8-a482-4983-a032-3dafe8085a91":{"description":"Invalid parameter","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"0330c676-0ee2-46b8-9e7d-ad532180a7c2":{"description":"Missing, invalid or inactive API key","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"264697f9-28e2-45c9-8b22-cb8bc720e324":{"description":"A contact with this email already exists","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"db89d7fe-7f49-4e0b-9207-6ca843836031":{"description":"Validation error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"193cb2a0-1462-4892-bb06-df3a3c753c89":{"description":"Rate limit exceeded (120 requests/minute per key owner)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"0d54c6f9-b00e-4cbe-9e35-3f31f5588c37":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key from Business Tools → API Access.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1c11b178-1dad-4dc1-8244-275954f6bbdf":{"url":"https://api.hiveinspect.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key from Business Tools → API Access.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key from Business Tools → API Access.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/openapi.json"},"subdomain":"hiveinspect-43c85ed1","siteName":"Hive Inspect","title":"Create a contact - Hive Inspect","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api/contacts/create-a-contact.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Hive Inspect\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a contact - Hive Inspect\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hive Inspect\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hiveinspect.com/api/contacts/create-a-contact\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.hiveinspect.com/images/og-cover.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a contact - Hive Inspect\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.hiveinspect.com/images/og-cover.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hiveinspect-43c85ed1/SjJwHLJlpEJWMouy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hive Inspect\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0166c2\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Hive Inspect home inspection software on laptop, tablet, and phone\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Hive Inspect home inspection software on laptop, tablet, and phone\">\u003cmeta data-mint-head name=\"author\" content=\"Hive Inspect\">\u003cmeta data-mint-head name=\"msvalidate.01\" content=\"72D895BDDEC4A34D44A2F5971922D98A\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hiveinspect.com/api/contacts/create-a-contact\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/contacts/create-a-contact.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.hiveinspect.com/#organization\",\"name\":\"Hive Inspect\",\"legalName\":\"Synapse Mobility, Inc.\",\"url\":\"https://www.hiveinspect.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.hiveinspect.com/images/shared/logo.png\"},\"sameAs\":[\"https://www.hiveinspect.com/\",\"https://apps.apple.com/us/app/hive-inspect/id6737940474\",\"https://play.google.com/store/apps/details?id=com.singaporv.estategpt\",\"https://www.instagram.com/hive.inspect/\",\"https://www.facebook.com/profile.php?id=61577925876518\",\"https://www.facebook.com/groups/1202950231646461\",\"https://www.youtube.com/@hiveinspect\",\"https://www.linkedin.com/company/hive-inspect\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hiveinspect.com#website\",\"name\":\"Hive Inspect\",\"url\":\"https://docs.hiveinspect.com\",\"publisher\":{\"@id\":\"https://www.hiveinspect.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact#webpage\",\"url\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact\",\"name\":\"Create a contact\",\"isPartOf\":{\"@id\":\"https://docs.hiveinspect.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Contacts\",\"item\":\"https://docs.hiveinspect.com/api/contacts/list-contacts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a contact\",\"item\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact#apireference\",\"headline\":\"Create a contact\",\"name\":\"Create a contact\",\"url\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hiveinspect.com/api/contacts/create-a-contact#webpage\"},\"image\":\"https://docs.hiveinspect.com/images/og-cover.png\",\"publisher\":{\"@id\":\"https://www.hiveinspect.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hiveinspect.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hive Inspect\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hive Inspect\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/contacts/create-a-contact.md","siteName":"Hive Inspect","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"compass","pages":[{"title":"Guides","href":""}]},{"tab":"Videos","icon":"circle-play","pages":[{"title":"Videos","href":"/video-tutorials"}]},{"tab":"How-Tos","icon":"clipboard-check","pages":[{"title":"How-Tos","href":"/how-tos"}]},{"tab":"FAQs","icon":"circle-help","pages":[{"title":"FAQs","href":"/faq"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"API","icon":"code","groups":[{"group":"Getting started","pages":[{"title":"Hive Inspect API: Connect Your Tools to Your Hive Data","sidebarTitle":"Introduction","href":"/api/introduction"},{"title":"API Authentication: Create and Use Hive Inspect API Keys","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"API Pagination: Page Through Long Lists With a Cursor","sidebarTitle":"Pagination","href":"/api/pagination"},{"title":"API Dates and Time Zones: How Hive Date Filters Work","sidebarTitle":"Dates and time zones","href":"/api/dates-and-time-zones"},{"title":"API Rate Limits and Errors: Status Codes and Retries","sidebarTitle":"Rate limits and errors","href":"/api/rate-limits-and-errors"},{"title":"Build an Efficient Integration With the Hive Inspect API","sidebarTitle":"Efficient integrations","href":"/api/efficient-integrations"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/contacts","href":"/api/contacts/list-contacts"},{"title":"Get a contact","description":null,"deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/contacts/{contactId}","href":"/api/contacts/get-a-contact"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/contacts","href":"/api/contacts/create-a-contact"},{"title":"Update a contact","description":null,"deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/contacts/{contactId}","href":"/api/contacts/update-a-contact"},{"title":"List contact stats","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/contacts/stats","href":"/api/contacts/list-contact-stats"},{"title":"Contact Tags and Photos in the API","sidebarTitle":"Tags and photos","href":"/api/contact-tags-and-photos"},{"title":"List tags","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/tags","href":"/api/contacts/list-tags"},{"title":"Add tags to a contact","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/contacts/{contactId}/tags","href":"/api/contacts/add-tags-to-a-contact"},{"title":"Remove a tag from a contact","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/contacts/{contactId}/tags/{tagId}","href":"/api/contacts/remove-a-tag-from-a-contact"},{"title":"Upload a contact photo","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/contacts/{contactId}/photo","href":"/api/contacts/upload-a-contact-photo"},{"title":"Remove a contact photo","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/contacts/{contactId}/photo","href":"/api/contacts/remove-a-contact-photo"}]},{"group":"Agencies","pages":[{"title":"Agencies in the API: Link Contacts to Their Brokerage","sidebarTitle":"How agencies work","href":"/api/agencies"},{"title":"List agencies","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/agencies","href":"/api/agencies/list-agencies"},{"title":"Get an agency","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/agencies/{agencyId}","href":"/api/agencies/get-an-agency"}]},{"group":"Inspections","pages":[{"title":"List inspections","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/inspections","href":"/api/inspections/list-inspections"},{"title":"Get an inspection","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/inspections/{inspectionId}","href":"/api/inspections/get-an-inspection"},{"title":"Inspection Payments in the API: Invoices, Payer Shares and Refunds","sidebarTitle":"How payments work","href":"/api/inspection-payments"},{"title":"Get an inspection's payments","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/inspections/{inspectionId}/payments","href":"/api/inspections/get-an-inspections-payments"}]},{"group":"Attachments","pages":[{"title":"Attachments in the API: Reports and Documents on Inspections","sidebarTitle":"How attachments work","href":"/api/attachments"},{"title":"List attachments across inspections","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/attachments","href":"/api/attachments/list-attachments-across-inspections"},{"title":"List attachments","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/inspections/{inspectionId}/attachments","href":"/api/attachments/list-attachments"},{"title":"Upload an attachment","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/inspections/{inspectionId}/attachments","href":"/api/attachments/upload-an-attachment"}]},{"group":"Events","pages":[{"title":"List inspection events","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/events","href":"/api/events/list-inspection-events"}]},{"group":"Webhooks","pages":[{"title":"Webhooks: Get Notified When Inspections and Contacts Change","sidebarTitle":"Set up webhooks","href":"/api/webhooks"},{"title":"Webhook Events and Payloads in the Hive Inspect API","sidebarTitle":"Events and payloads","href":"/api/webhook-events"},{"title":"Verify Webhook Signatures From Hive Inspect","sidebarTitle":"Verify signatures","href":"/api/webhook-signatures"}]},{"group":"MCP","pages":[{"title":"Connect Claude, ChatGPT or Grok to Hive Inspect With MCP","sidebarTitle":"Connect an AI assistant","href":"/api/mcp"}]}]},{"tab":"What's new","icon":"megaphone","pages":[{"title":"What's new","href":"/whats-new/overview"}]}]},"basePath":"","title":"Create a contact - Hive Inspect","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}