Create intake

POST/workspaces/{organizationId}/intake

Path parameters

organizationIdstringrequired

Request body

application/json

intakeIdstring

min length 1

businessNamestringrequired

min length 1

addressstring

websiteUrlstring<uri>

visitedAtstring

spokeWithobject

Show properties

namestring

rolestring

isDecisionMakerboolean

ownerobject

Show properties

namestring

phonestring

emailstring<email>

bestTimestring

meetingobject

Show properties

bookedbooleanrequired

atstring

returnAtstring

bookingUrlstring<uri>

discoveryobject

Show properties

businessTypestring

billingSystemsstring[]

paymentMethodsstring[]

hardwarestring

hardwareOwnershipstring

signagestring

fitNotesstring

pricingobject

Show properties

currentProcessorstring

posSystemstring

underContractboolean

contractEndstring

earlyTerminationFeestring

timeWithProviderstring

monthlyCardVolumestring

averageTicketstring

transactionsPerDaystring

cardMixstring

channelMixstring

seasonalitystring

monthlySalesTotalsstring

painobject

Show properties

biggestComplaintstring

switchedBeforestring

wishesstring

pipelineStatusIdstring

nextStepstring

nextStepDatestring

repNotesstring

statementFilesobject[]

Show properties

Array of object

keystringrequired

min length 1

urlstringrequired

min length 1

namestring

Responses

200

Intake already recorded (idempotent retry)

customerIdstringrequired

contactIdstring | nullrequired

documentIdstring | nullrequired

statusIdstring | nullrequired

bookingLinkIdstring | nullrequired

dedupedbooleanrequired

201

Intake recorded

customerIdstringrequired

contactIdstring | nullrequired

documentIdstring | nullrequired

statusIdstring | nullrequired

bookingLinkIdstring | nullrequired

dedupedbooleanrequired

400

Invalid request

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

{
  "intakeId": "string",
  "businessName": "string",
  "address": "string",
  "websiteUrl": "http://example.com",
  "visitedAt": "string",
  "spokeWith": {
    "name": "string",
    "role": "string",
    "isDecisionMaker": true
  },
  "owner": {
    "name": "string",
    "phone": "string",
    "email": "user@example.com",
    "bestTime": "string"
  },
  "meeting": {
    "booked": true,
    "at": "string",
    "returnAt": "string",
    "bookingUrl": "http://example.com"
  },
  "discovery": {
    "businessType": "string",
    "billingSystems": [
      "string"
    ],
    "paymentMethods": [
      "string"
    ],
    "hardware": "string",
    "hardwareOwnership": "string",
    "signage": "string",
    "fitNotes": "string"
  },
  "pricing": {
    "currentProcessor": "string",
    "posSystem": "string",
    "underContract": true,
    "contractEnd": "string",
    "earlyTerminationFee": "string",
    "timeWithProvider": "string",
    "monthlyCardVolume": "string",
    "averageTicket": "string",
    "transactionsPerDay": "string",
    "cardMix": "string",
    "channelMix": "string",
    "seasonality": "string",
    "monthlySalesTotals": "string"
  },
  "pain": {
    "biggestComplaint": "string",
    "switchedBefore": "string",
    "wishes": "string"
  },
  "pipelineStatusId": "string",
  "nextStep": "string",
  "nextStepDate": "string",
  "repNotes": "string",
  "statementFiles": [
    {
      "key": "string",
      "url": "string",
      "name": "string"
    }
  ]
}

Request

curl -X POST '/workspaces/string/intake' \
  -H 'Content-Type: application/json' \
  -d '{
  "intakeId": "string",
  "businessName": "string",
  "address": "string",
  "websiteUrl": "http://example.com",
  "visitedAt": "string",
  "spokeWith": {
    "name": "string",
    "role": "string",
    "isDecisionMaker": true
  },
  "owner": {
    "name": "string",
    "phone": "string",
    "email": "user@example.com",
    "bestTime": "string"
  },
  "meeting": {
    "booked": true,
    "at": "string",
    "returnAt": "string",
    "bookingUrl": "http://example.com"
  },
  "discovery": {
    "businessType": "string",
    "billingSystems": [
      "string"
    ],
    "paymentMethods": [
      "string"
    ],
    "hardware": "string",
    "hardwareOwnership": "string",
    "signage": "string",
    "fitNotes": "string"
  },
  "pricing": {
    "currentProcessor": "string",
    "posSystem": "string",
    "underContract": true,
    "contractEnd": "string",
    "earlyTerminationFee": "string",
    "timeWithProvider": "string",
    "monthlyCardVolume": "string",
    "averageTicket": "string",
    "transactionsPerDay": "string",
    "cardMix": "string",
    "channelMix": "string",
    "seasonality": "string",
    "monthlySalesTotals": "string"
  },
  "pain": {
    "biggestComplaint": "string",
    "switchedBefore": "string",
    "wishes": "string"
  },
  "pipelineStatusId": "string",
  "nextStep": "string",
  "nextStepDate": "string",
  "repNotes": "string",
  "statementFiles": [
    {
      "key": "string",
      "url": "string",
      "name": "string"
    }
  ]
}'

const response = await fetch("/workspaces/string/intake", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"intakeId\": \"string\",\n  \"businessName\": \"string\",\n  \"address\": \"string\",\n  \"websiteUrl\": \"http://example.com\",\n  \"visitedAt\": \"string\",\n  \"spokeWith\": {\n    \"name\": \"string\",\n    \"role\": \"string\",\n    \"isDecisionMaker\": true\n  },\n  \"owner\": {\n    \"name\": \"string\",\n    \"phone\": \"string\",\n    \"email\": \"user@example.com\",\n    \"bestTime\": \"string\"\n  },\n  \"meeting\": {\n    \"booked\": true,\n    \"at\": \"string\",\n    \"returnAt\": \"string\",\n    \"bookingUrl\": \"http://example.com\"\n  },\n  \"discovery\": {\n    \"businessType\": \"string\",\n    \"billingSystems\": [\n      \"string\"\n    ],\n    \"paymentMethods\": [\n      \"string\"\n    ],\n    \"hardware\": \"string\",\n    \"hardwareOwnership\": \"string\",\n    \"signage\": \"string\",\n    \"fitNotes\": \"string\"\n  },\n  \"pricing\": {\n    \"currentProcessor\": \"string\",\n    \"posSystem\": \"string\",\n    \"underContract\": true,\n    \"contractEnd\": \"string\",\n    \"earlyTerminationFee\": \"string\",\n    \"timeWithProvider\": \"string\",\n    \"monthlyCardVolume\": \"string\",\n    \"averageTicket\": \"string\",\n    \"transactionsPerDay\": \"string\",\n    \"cardMix\": \"string\",\n    \"channelMix\": \"string\",\n    \"seasonality\": \"string\",\n    \"monthlySalesTotals\": \"string\"\n  },\n  \"pain\": {\n    \"biggestComplaint\": \"string\",\n    \"switchedBefore\": \"string\",\n    \"wishes\": \"string\"\n  },\n  \"pipelineStatusId\": \"string\",\n  \"nextStep\": \"string\",\n  \"nextStepDate\": \"string\",\n  \"repNotes\": \"string\",\n  \"statementFiles\": [\n    {\n      \"key\": \"string\",\n      \"url\": \"string\",\n      \"name\": \"string\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "/workspaces/string/intake",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"intakeId\": \"string\",\n  \"businessName\": \"string\",\n  \"address\": \"string\",\n  \"websiteUrl\": \"http://example.com\",\n  \"visitedAt\": \"string\",\n  \"spokeWith\": {\n    \"name\": \"string\",\n    \"role\": \"string\",\n    \"isDecisionMaker\": true\n  },\n  \"owner\": {\n    \"name\": \"string\",\n    \"phone\": \"string\",\n    \"email\": \"user@example.com\",\n    \"bestTime\": \"string\"\n  },\n  \"meeting\": {\n    \"booked\": true,\n    \"at\": \"string\",\n    \"returnAt\": \"string\",\n    \"bookingUrl\": \"http://example.com\"\n  },\n  \"discovery\": {\n    \"businessType\": \"string\",\n    \"billingSystems\": [\n      \"string\"\n    ],\n    \"paymentMethods\": [\n      \"string\"\n    ],\n    \"hardware\": \"string\",\n    \"hardwareOwnership\": \"string\",\n    \"signage\": \"string\",\n    \"fitNotes\": \"string\"\n  },\n  \"pricing\": {\n    \"currentProcessor\": \"string\",\n    \"posSystem\": \"string\",\n    \"underContract\": true,\n    \"contractEnd\": \"string\",\n    \"earlyTerminationFee\": \"string\",\n    \"timeWithProvider\": \"string\",\n    \"monthlyCardVolume\": \"string\",\n    \"averageTicket\": \"string\",\n    \"transactionsPerDay\": \"string\",\n    \"cardMix\": \"string\",\n    \"channelMix\": \"string\",\n    \"seasonality\": \"string\",\n    \"monthlySalesTotals\": \"string\"\n  },\n  \"pain\": {\n    \"biggestComplaint\": \"string\",\n    \"switchedBefore\": \"string\",\n    \"wishes\": \"string\"\n  },\n  \"pipelineStatusId\": \"string\",\n  \"nextStep\": \"string\",\n  \"nextStepDate\": \"string\",\n  \"repNotes\": \"string\",\n  \"statementFiles\": [\n    {\n      \"key\": \"string\",\n      \"url\": \"string\",\n      \"name\": \"string\"\n    }\n  ]\n}",
)

Response

{
  "customerId": "string",
  "contactId": "string",
  "documentId": "string",
  "statusId": "string",
  "bookingLinkId": "string",
  "deduped": true
}

{
  "customerId": "string",
  "contactId": "string",
  "documentId": "string",
  "statusId": "string",
  "bookingLinkId": "string",
  "deduped": true
}