Skip to main content

Hot Prospects

EntityRelationshipCommercialRelationship.HotProspect

A Hot Prospect is an engaged lead showing strong buying signals — typically a Lead that has responded to outreach, requested a demo, or otherwise progressed beyond initial contact. Hot Prospects sit between Leads and qualified Prospects in the sales funnel.

The TribeCRM commercial funnel is: SuspectLead → HotProspect → ProspectCustomer.

Two variants
  • Organisation Hot ProspectRelationship_Organization_CommercialRelationship_HotProspect — when the prospect is a company.
  • Person Hot ProspectRelationship_Person_CommercialRelationship_HotProspect — when the prospect is an individual (B2C).

Both share the same fields and lifecycle; the only difference is which Relation subtype is linked (Organization vs Person).

Endpoints

List Hot Prospects

Retrieve a paginated list of hot prospects.

Organisation (B2B)

GET/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect

Person (B2C)

GET/v1/odata/Relationship_Person_CommercialRelationship_HotProspect

Single Hot Prospect

Retrieve a single hot prospect by its ID.

Organisation (B2B)

GET/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect({id})

Person (B2C)

GET/v1/odata/Relationship_Person_CommercialRelationship_HotProspect({id})

Create Hot Prospect with a New Relation

Create a hot prospect relationship and its underlying Organisation or Person in one call.

Organisation (B2B)

POST/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect

Person (B2C)

POST/v1/odata/Relationship_Person_CommercialRelationship_HotProspect
  • Relation.ID — The parent Relation (typically your own organisation).
  • Organization / Person — The child Relation fields (created automatically). For Person, LastName is mandatory.

Create Hot Prospect from an Existing Relation

Link an existing Organisation or Person as a hot prospect.

Organisation (B2B)

POST/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect

Person (B2C)

POST/v1/odata/Relationship_Person_CommercialRelationship_HotProspect

Update Hot Prospect

Update an existing hot prospect relationship. Provide only the fields to update.

Organisation (B2B)

PUT/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect({id})

Person (B2C)

PUT/v1/odata/Relationship_Person_CommercialRelationship_HotProspect({id})

Convert Hot Prospect to next funnel stage

Promote a Hot Prospect to a Prospect or Customer by changing its _Type. All linked activities, notes, and history are preserved.

Organisation (B2B)

POST/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect

Person (B2C)

POST/v1/odata/Relationship_Person_CommercialRelationship_HotProspect

Use the Relationship ID, not any of the Relation IDs.

note

Type conversion only works within the same Relation type: an Organisation Hot Prospect can become an Organisation Prospect/Customer, a Person Hot Prospect can become a Person Prospect/Customer. You cannot cross-convert between Organisation and Person variants.

Delete Hot Prospect

Delete a hot prospect relationship by ID. This removes the role but does not delete the underlying Organisation or Person.

Organisation (B2B)

DELETE/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect({id})

Person (B2C)

DELETE/v1/odata/Relationship_Person_CommercialRelationship_HotProspect({id})

Fields

Standard Fields (all entities)

FieldTypeDescription
IDGuidPrimary key (UUID)
_TypeStringEntity type discriminator (Relationship.Organization.CommercialRelationship.HotProspect or Relationship.Person.CommercialRelationship.HotProspect)
_NameStringComputed display name
SortIndexDoubleSorting order
CreationDateDateTimeOffsetDate the record was created
LastMutationDateDateTimeOffsetDate of the last modification
IsActiveBooleanWhether the record is active
IsClosedBooleanWhether the record is closed

Hot Prospect Fields

FieldTypeDescription
NameStringHot Prospect display name

Relationships

RelationshipTarget EntityCardinalityDescription
RelationRelationN:1Parent relation (your organisation)
OrganizationRelation.OrganizationN:1B2B only: the hot prospect organisation
PersonRelation.PersonN:1B2C only: the hot prospect person
StatusDatastoreN:1Hot Prospect status

Expanding Relationships

GET/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect({id})?$expand=Organization,Relation
GET/v1/odata/Relationship_Person_CommercialRelationship_HotProspect({id})?$expand=Person,Relation
GET/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect({id})/Relation

Filtering Examples

The same $filter syntax applies to both Organisation and Person variants — substitute the entity URL accordingly.

GET/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Relationship_Person_CommercialRelationship_HotProspect?$filter=CreationDate gt {CreationDate}&$top={top}
GET/v1/odata/Relationship_Organization_CommercialRelationship_HotProspect?$filter=IsClosed eq {IsClosed}&$top={top}