Contacts

Deletes an existing contact, scoped by the company/business unit of the current user

Deletes the contact and dissociate it from a vendor

Securitybearer
Request
path Parameters
contactId
required
string <uuid>

The contact's guid

header Parameters
BusinessUnitId
string

The business unit's guid

Responses
204

No Content

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

delete/api/v1/contacts/{contactId}
Request samples 
Returns a contact with the provided id, scoped by the company/business unit of the current user
The contact that is associated with a vendor


Securitybearer 
Request 
path Parameters
contactId
required
string <uuid> 
The contact's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/contacts/{contactId}
Request samples 
Response samples 
application/json
{
  • "id": "4133084c-38fe-4364-88e5-64ff5753cadd",
  • "companyId": "395c067c-b097-4070-8569-ed055a6a815b",
  • "companyName": "Petersons Construction INC",
  • "firstName": "Charles",
  • "lastName": "Petersons",
  • "title": "Manager",
  • "phoneNumber": "800-277-2828",
  • "faxNumber": "800-278-2727",
  • "cellPhoneNumber": "281-268-7648",
  • "emailAddress": "charles@petersons-construction.com",
  • "isMainContact": true,
  • "note": "Main contact",
  • "role": "Customer Success",
  • "lastContacted": "2024-03-27T18:46:49.9698891Z",
  • "vendorLocationId": "33ebfc1c-c35c-48c6-86b8-585d832833e2"
}
Updates a contact, scoped by the company/business unit of the current user
Updates an existing contact that is associated with a vendor


Securitybearer 
Request 
path Parameters
contactId
required
string <uuid> 
The contact's guid


 
query Parameters
vendorId
required
string <uuid> 
The vendor's guid


 
moveVendorContact
boolean
Option to move the contact to another vendor


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: application/json
The contact


vendorId
required
string <uuid> 
The vendor's unique identifier.


 
contactId
required
string <uuid> 
The contact's unique identifier.


 
firstName
string or null
The contact's first name.


 
lastName
string or null
The contact's last name.


 
title
string or null
The contact's title.


 
phoneNumber
string or null
The contact's phone number.


 
faxNumber
string or null
The contact's fax number.


 
cellPhoneNumber
string or null
The contact's cell phone number.


 
emailAddress
string or null
The contact's email address.


 
note
string or null
The contact's note.


 
isMainContact
boolean
A boolean indicating whether this contact is the company's main contact.


 
role
string or null  <= 30 characters 
A string specifying a contact's role.


 
lastContacted
string or null <date-time> 
A DateTime when this contact was last contacted.


 
vendorLocationId
string or null <uuid> 
A Location this contact tie to.


 
Responses 
put/api/v1/contacts/{contactId}
Request samples 
application/json
{
  • "vendorId": "6f2cd86e-21d0-4486-afd0-f4ac24648f4d",
  • "contactId": "81a25b86-9cd0-4436-aa6a-9e0ac8ed22ec",
  • "firstName": "Charles",
  • "lastName": "Petersons",
  • "title": "Manager",
  • "phoneNumber": "800-277-2828",
  • "faxNumber": "800-278-2727",
  • "cellPhoneNumber": "281-268-7648",
  • "emailAddress": "charles@petersons-construction.com",
  • "note": "Main contact",
  • "isMainContact": true,
  • "role": "Customer Success",
  • "lastContacted": "2024-03-27T18:46:49.974655Z",
  • "vendorLocationId": "bbee94d6-20e9-4fd4-8ba5-18c9f2da0b23"
}
Returns a list of all contacts that are associated with a vendor, scoped by the company/business unit of the current user
Securitybearer 
Request 
query Parameters
vendorId
required
string <uuid> 
The vendor's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/contacts
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new contact for a vendor, scoped by the company/business unit of the current user
Creates a contact that would be associated to a vendor


Securitybearer 
Request 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: application/json
The contact


vendorId
required
string <uuid> 
The vendor's unique identifier.


 
firstName
string or null
The contact's first name.


 
lastName
string or null
The contact's last name.


 
title
string or null
The contact's title.


 
phoneNumber
string or null
The contact's phone number.


 
faxNumber
string or null
The contact's fax number.


 
cellPhoneNumber
string or null
The contact's cell phone number.


 
emailAddress
string or null
The contact's email address.


 
note
string or null
The contact's note.


 
isMainContact
boolean
A boolean indicating whether this contact is the company's main contact.


 
role
string or null  <= 30 characters 
A string specifying a contact's role.


 
lastContacted
string or null <date-time> 
A DateTime when this contact was last contacted.


 
vendorLocationId
string or null <uuid> 
A Location tie to this contact.


 
Array of objects or null (ContactProductDto) 
Products tie to this contact.


 
Responses 
post/api/v1/contacts
Request samples 
application/json
{
  • "vendorId": "ae41c6c1-5239-4640-9dd2-2e3d2168e1b4",
  • "firstName": "Charles",
  • "lastName": "Petersons",
  • "title": "Manager",
  • "phoneNumber": "800-277-2828",
  • "faxNumber": "800-278-2727",
  • "cellPhoneNumber": "281-268-7648",
  • "emailAddress": "charles@petersons-construction.com",
  • "note": "Main contact",
  • "isMainContact": true,
  • "role": "Customer Success",
  • "lastContacted": "2024-03-27T18:46:50.0215495Z",
  • "vendorLocationId": "e011c154-289d-48f3-884e-7875f45ed93a",
  • "products": [
    ]
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"