Skip to main content
POST
Dismiss prospect

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

contactId
string
required

Body

application/json
requestId
string
required
expectedRevision
required
reason
string
required

Response

Success

contactId
string
required
name
string
required
kind
string
required
companyId
string | null
required
companyName
string | null
required
email
string | null
required
mobile
string | null
required
contactArchivedAt
string | null
required
isContractor
boolean
required
status
string
required
trades
string[]
required
coverageAreas
string[]
required
availability
string
required
availableFrom
string | null
required
availabilityNote
string | null
required
preferenceRank
required
ratesNotes
string | null
required
notes
string | null
required
deactivatedAt
string | null
required
deactivationReason
string | null
required
deactivatedByName
string | null
required
revision
required
updatedAt
string | null
required
credentials
object[]
required
prospect
object | null
required