Skip to main content
POST
Add prospect

Authorizations

x-api-key
string
header
required

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

Body

application/json
requestId
string
required
externalId
string
required
name
string
required
phone
string · null · null
email
string · null · null
website
string · null · null
addressLine1
string · null · null
town
string · null · null
postcode
string · null · null
trades
string[] | null
coverageAreas
string[] | null
searchTrade
string · null · null
searchPostcode
string · null · null

Response

Success

contractor
object
required
alreadyAdded
boolean
required