RetailHardHat Developer docs

REST API documentation

Bid Contacts

Contacts associated with specific bids

Supported operations

MethodPathDescription
GET/api/v1/bids/:bidId/contactsList contacts for a bid
POST/api/v1/bids/:bidId/contactsAdd a contact to a bid
PATCH/api/v1/bids/:bidId/contacts/:idUpdate a bid contact
DELETE/api/v1/bids/:bidId/contacts/:idDelete a bid contact

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
bidIduuidRequiredbid Id

Related resource: bids

namestringRequiredname
emailstringOptionalemail
phonestringOptionalphone
titlestringOptionaltitle
companystringOptionalcompany
notesstringOptionalnotes
isPrimarybooleanOptionalis Primary
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)