Contacts

Create a contact

post/v1/contacts

Request

  • Base URL: https://api.hiveinspect.com
  • URL: https://api.hiveinspect.com/v1/contacts
  • Auth: HTTP bearer

Request body

first_namestring required
last_namestring nullable
emailstring email required
cc_emailstring nullable

One or more CC email addresses, separated by commas (up to 10)

phonestring nullable
business_namestring nullable
agency_namestring nullable

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.

addressstring nullable
address_line2string nullable
citystring nullable
statestring nullable
zipstring nullable
countrystring nullable

ISO-2, e.g. US or CA

birthdaystring date nullable
websitestring nullable
socialobject nullable
notesstring nullable
agency_idstring uuid nullable

Link the contact to an agency from /v1/agencies. Takes precedence over agency_name.

uses_agency_addressboolean nullable

true: use the agency's address for this contact. false: keep the contact's own address.

tag_idsstring[] nullable

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.

tagsstring[] nullable

Replace the contact's tags with these tag names (case-insensitive). The tags must already exist.

Example request

{
  "first_name": "Dana",
  "last_name": "Reyes",
  "email": "dana@example.com",
  "phone": "(512) 555-0142",
  "agency_id": "6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c",
  "tags": [
    "Top agent"
  ]
}

Response

Created

idstring uuid
first_namestring
last_namestring nullable
emailstring email
cc_emailstring nullable

One or more CC email addresses, separated by commas (up to 10)

phonestring nullable
business_namestring nullable
agency_namestring nullable
addressstring nullable
address_line2string nullable
citystring nullable
statestring nullable
zipstring nullable
countrystring nullable

ISO-2, e.g. US or CA

birthdaystring date nullable
websitestring nullable
socialobject nullable
notesstring nullable
rolesstring[]

Distinct roles this contact has had on inspections

created_atstring date-time
updated_atstring date-time
photo_urlstring nullable

Signed link, valid for 1 hour

agency_idstring uuid nullable

The agency (brokerage) this contact is linked to, from /v1/agencies. Null when agency_name is plain text.

uses_agency_addressboolean

true: the contact's address follows the agency's address

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.