BatchCreateProspectsResponse

Response model for batch prospect creation.

created
Type: array object[] · BatchProspectResultItem[]

Successfully created prospects.
A successfully created prospect in a batch operation.
- id
  Type: string
  required
  
  The created prospect ID.
- companyId
  Type: null | string
  
  The company ID if prospect is linked to a company.
- contactId
  Type: null | string
  
  The contact ID if prospect is linked to a contact.
- externalRefs
  Type: array object[] | null · ExternalRef[]
  
  External references that were created for this prospect.
  
  Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.
failed
Type: array object[] · BatchProspectFailedItem[]

Items that failed to be created.
A failed item in a batch prospect creation.
- error
  Type: string
  required
  
  Error code: validation_error, invalid_id, duplicate, duplicate_external_ref, already_in_prospects, already_in_incoming, blocked, invalid_source, not_found_or_no_access, or action_failed.
- message
  Type: string
  required
  
  Human-readable error message.
- companyId
  Type: null | string
  
  The company ID from the request (if provided).
- contactId
  Type: null | string
  
  The contact ID from the request (if provided).
- index
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  
  The index of the failed item in the request array.