ContactProducts

Deletes an existing product that is associated with a contact, scoped by the company/business unit of the current user

Deletes the product and dissociate it from a contact

Securitybearer
Request
path Parameters
contactId
required
string <uuid>

The contact's guid

header Parameters
BusinessUnitId
string

The business unit's guid

Request Body schema:

The product

vendorId
string <uuid>

The vendor's unique identifier.

contactId
string <uuid>

The contact's unique identifier.

vendorProductId
string <uuid>

The product unique identifier.

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/products/{contactId}/products
Request samples
{
  • "vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "vendorProductId": "9ec5a653-9c40-4505-b3c3-004141cec438"
}

Returns a list of all products associated with a contact, scoped by the company/business unit of the current user

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/products/{contactId}/products
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new product to be associated with a contact, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
contactId
required
string <uuid> 
The contact's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: application/json
The product


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


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


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


 
Responses 
post/api/v1/products/{contactId}/products
Request samples 
application/json
{
  • "vendorId": "14d92f9d-df1a-4e94-9b25-b8ac362298d7",
  • "contactId": "29969bf7-9ca3-4c62-a2ff-32cb33daad71",
  • "vendorProductId": "5e4494e1-eb59-4c52-9aee-7400ea3a74ab"
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"