Deal Distribution Recipients | RetailHardHat REST API docs

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

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.

Field	Type	Model requirement	Description
`id`	`string`	Optional	Unique identifier (auto-generated)
`distributionId`	`uuid`	Required	distribution Id Related resource: `dealDistributions`
`criteriaProfileId`	`uuid`	Optional	criteria Profile Id
`recipientType`	`enum`	Optional	recipient Type Values: `investor`, `lender`, `partner`, `broker`, `other`
`recipientName`	`string`	Required	recipient Name
`recipientCompany`	`string`	Optional	recipient Company
`recipientEmail`	`string`	Optional	recipient Email
`recipientPhone`	`string`	Optional	recipient Phone
`contactUserId`	`uuid`	Optional	contact User Id
`matchScore`	`number`	Optional	match Score
`matchDetails`	`json`	Optional	match Details
`meetsRequiredCriteria`	`boolean`	Optional	meets Required Criteria
`wasAutoMatched`	`boolean`	Optional	was Auto Matched
`wasManuallyAdded`	`boolean`	Optional	was Manually Added
`wasManuallyExcluded`	`boolean`	Optional	was Manually Excluded
`exclusionReason`	`string`	Optional	exclusion Reason
`isSent`	`boolean`	Optional	is Sent
`sentAt`	`datetime`	Optional	sent At
`deliveryMethod`	`string`	Optional	delivery Method
`deliveryStatus`	`string`	Optional	delivery Status
`deliveryError`	`string`	Optional	delivery Error
`firstAccessedAt`	`datetime`	Optional	first Accessed At
`lastAccessedAt`	`datetime`	Optional	last Accessed At
`accessCount`	`number`	Optional	access Count
`hasResponded`	`boolean`	Optional	has Responded
`responseType`	`enum`	Optional	response Type Values: `pass`, `soft_interest`, `request_info`, `full_interest`, `committed`
`respondedAt`	`datetime`	Optional	responded At
`ndaSigned`	`boolean`	Optional	nda Signed
`ndaSignedAt`	`datetime`	Optional	nda Signed At
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)