CreateProspectRequest

Request model for adding a prospect to a project. Prefer contactId — contacts have email/phone for direct outreach and support more capabilities. Use companyId only as a placeholder when the specific person is unknown.

  • companyId
    Type: null | string

    Company ID to add as prospect. Use only when the specific contact person is unknown. Mutually exclusive with contactId.

  • contactId
    Type: null | string

    Contact ID to add as prospect (preferred). Mutually exclusive with companyId.

  • externalRefs
    Type: array object[] | null · ExternalRef[]

    External references for CRM integration (e.g., Salesforce, HubSpot). Each namespace can only appear once. Multiple CRM systems can be referenced simultaneously.

    Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.

    • id
      Type: string
      max length:  
      255
      required

      External identifier within the namespace (e.g., "003XXXXXXXXXXXX" for Salesforce). Case-sensitive. Format depends on the external system.

    • namespace
      Type: string
      max length:  
      50
      required

      External system namespace (e.g., "salesforce", "hubspot", "pipedrive", "csv-import"). Case-insensitive.