Create Opportunity

curl --request POST \
  --url https://api.decodahealth.com/opportunity \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "sourceDetail": "<string>",
  "campaignId": "<string>",
  "locationId": "<string>",
  "patientId": "<string>",
  "pipelineId": "<string>",
  "currentStageId": "<string>",
  "assignedProviderId": "<string>",
  "notes": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/opportunity"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "sourceDetail": "<string>",
    "campaignId": "<string>",
    "locationId": "<string>",
    "patientId": "<string>",
    "pipelineId": "<string>",
    "currentStageId": "<string>",
    "assignedProviderId": "<string>",
    "notes": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '<string>',
    phoneNumber: '<string>',
    sourceDetail: '<string>',
    campaignId: '<string>',
    locationId: '<string>',
    patientId: '<string>',
    pipelineId: '<string>',
    currentStageId: '<string>',
    assignedProviderId: '<string>',
    notes: '<string>'
  })
};

fetch('https://api.decodahealth.com/opportunity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/opportunity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '<string>',
    'phoneNumber' => '<string>',
    'sourceDetail' => '<string>',
    'campaignId' => '<string>',
    'locationId' => '<string>',
    'patientId' => '<string>',
    'pipelineId' => '<string>',
    'currentStageId' => '<string>',
    'assignedProviderId' => '<string>',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/opportunity"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"sourceDetail\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"patientId\": \"<string>\",\n  \"pipelineId\": \"<string>\",\n  \"currentStageId\": \"<string>\",\n  \"assignedProviderId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/opportunity")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"sourceDetail\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"patientId\": \"<string>\",\n  \"pipelineId\": \"<string>\",\n  \"currentStageId\": \"<string>\",\n  \"assignedProviderId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/opportunity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"sourceDetail\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"patientId\": \"<string>\",\n  \"pipelineId\": \"<string>\",\n  \"currentStageId\": \"<string>\",\n  \"assignedProviderId\": \"<string>\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "firstName": "<string>",
  "pipelineId": "<string>",
  "patientId": "<string>",
  "stageEnteredAt": "2023-11-07T05:31:56Z",
  "lastName": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "sourceDetail": "<string>",
  "campaignId": "<string>",
  "locationId": "<string>",
  "currentStageId": "<string>",
  "assignedProviderId": "<string>",
  "status": "OPEN",
  "wonAt": "2023-11-07T05:31:56Z",
  "lostAt": "2023-11-07T05:31:56Z",
  "lostReasonId": "<string>",
  "lostReasonLabel": "<string>",
  "convertedDate": "2023-11-07T05:31:56Z",
  "lostReason": "<string>",
  "originatingTouchpointId": "<string>",
  "estValueCents": 123,
  "contactAttempts": 0,
  "firstResponseDueAt": "2023-11-07T05:31:56Z",
  "firstResponseAt": "2023-11-07T05:31:56Z",
  "lastEngagedAt": "2023-11-07T05:31:56Z",
  "automationsPaused": false,
  "stale": false,
  "isExistingPatient": false,
  "latestBooking": {
    "conversionId": "<string>",
    "eventId": "<string>",
    "occurredAt": "2023-11-07T05:31:56Z",
    "appointmentStart": "2023-11-07T05:31:56Z",
    "appointmentEnd": "2023-11-07T05:31:56Z",
    "isLinked": true,
    "locationName": "<string>",
    "isArchived": false
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "currentStage": {
    "id": "<string>",
    "pipelineId": "<string>",
    "name": "<string>",
    "stageNumber": 123,
    "color": "<string>",
    "kind": "WORKING",
    "staleAfterDays": 123,
    "isTerminalWon": false,
    "isTerminalLost": false,
    "autoConvert": false,
    "actions": [
      {
        "id": "<string>",
        "stageId": "<string>",
        "actionOrder": 123,
        "delayMinutes": 0,
        "config": {},
        "isActive": true
      }
    ]
  },
  "assignedProvider": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "campaign": {
    "id": "<string>",
    "name": "<string>",
    "locationId": "<string>",
    "description": "<string>",
    "platformId": "<string>",
    "platformAssetId": "<string>",
    "externalCampaignId": "<string>",
    "externalResourceName": "<string>",
    "externalName": "<string>",
    "externalStatus": "<string>",
    "externalCurrency": "<string>",
    "externalDailyBudgetCents": 123,
    "externalLifetimeBudgetCents": 123,
    "externalLastSeenAt": "2023-11-07T05:31:56Z",
    "externalLastSyncedAt": "2023-11-07T05:31:56Z",
    "externalStaleAt": "2023-11-07T05:31:56Z",
    "externalSyncError": "<string>",
    "isActive": true,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "budgetCents": 123,
    "pipelineId": "<string>",
    "webhook": {
      "webhookKey": "<string>",
      "webhookUrl": "<string>",
      "redirectUrl": "<string>"
    },
    "createdDate": "2023-11-07T05:31:56Z",
    "updatedDate": "2023-11-07T05:31:56Z",
    "opportunityCount": 0,
    "convertedCount": 0
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

opportunity

Create Opportunity

curl --request POST \
  --url https://api.decodahealth.com/opportunity \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "sourceDetail": "<string>",
  "campaignId": "<string>",
  "locationId": "<string>",
  "patientId": "<string>",
  "pipelineId": "<string>",
  "currentStageId": "<string>",
  "assignedProviderId": "<string>",
  "notes": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/opportunity"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "sourceDetail": "<string>",
    "campaignId": "<string>",
    "locationId": "<string>",
    "patientId": "<string>",
    "pipelineId": "<string>",
    "currentStageId": "<string>",
    "assignedProviderId": "<string>",
    "notes": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '<string>',
    phoneNumber: '<string>',
    sourceDetail: '<string>',
    campaignId: '<string>',
    locationId: '<string>',
    patientId: '<string>',
    pipelineId: '<string>',
    currentStageId: '<string>',
    assignedProviderId: '<string>',
    notes: '<string>'
  })
};

fetch('https://api.decodahealth.com/opportunity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/opportunity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '<string>',
    'phoneNumber' => '<string>',
    'sourceDetail' => '<string>',
    'campaignId' => '<string>',
    'locationId' => '<string>',
    'patientId' => '<string>',
    'pipelineId' => '<string>',
    'currentStageId' => '<string>',
    'assignedProviderId' => '<string>',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/opportunity"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"sourceDetail\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"patientId\": \"<string>\",\n  \"pipelineId\": \"<string>\",\n  \"currentStageId\": \"<string>\",\n  \"assignedProviderId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/opportunity")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"sourceDetail\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"patientId\": \"<string>\",\n  \"pipelineId\": \"<string>\",\n  \"currentStageId\": \"<string>\",\n  \"assignedProviderId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/opportunity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"sourceDetail\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"patientId\": \"<string>\",\n  \"pipelineId\": \"<string>\",\n  \"currentStageId\": \"<string>\",\n  \"assignedProviderId\": \"<string>\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "firstName": "<string>",
  "pipelineId": "<string>",
  "patientId": "<string>",
  "stageEnteredAt": "2023-11-07T05:31:56Z",
  "lastName": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "sourceDetail": "<string>",
  "campaignId": "<string>",
  "locationId": "<string>",
  "currentStageId": "<string>",
  "assignedProviderId": "<string>",
  "status": "OPEN",
  "wonAt": "2023-11-07T05:31:56Z",
  "lostAt": "2023-11-07T05:31:56Z",
  "lostReasonId": "<string>",
  "lostReasonLabel": "<string>",
  "convertedDate": "2023-11-07T05:31:56Z",
  "lostReason": "<string>",
  "originatingTouchpointId": "<string>",
  "estValueCents": 123,
  "contactAttempts": 0,
  "firstResponseDueAt": "2023-11-07T05:31:56Z",
  "firstResponseAt": "2023-11-07T05:31:56Z",
  "lastEngagedAt": "2023-11-07T05:31:56Z",
  "automationsPaused": false,
  "stale": false,
  "isExistingPatient": false,
  "latestBooking": {
    "conversionId": "<string>",
    "eventId": "<string>",
    "occurredAt": "2023-11-07T05:31:56Z",
    "appointmentStart": "2023-11-07T05:31:56Z",
    "appointmentEnd": "2023-11-07T05:31:56Z",
    "isLinked": true,
    "locationName": "<string>",
    "isArchived": false
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "currentStage": {
    "id": "<string>",
    "pipelineId": "<string>",
    "name": "<string>",
    "stageNumber": 123,
    "color": "<string>",
    "kind": "WORKING",
    "staleAfterDays": 123,
    "isTerminalWon": false,
    "isTerminalLost": false,
    "autoConvert": false,
    "actions": [
      {
        "id": "<string>",
        "stageId": "<string>",
        "actionOrder": 123,
        "delayMinutes": 0,
        "config": {},
        "isActive": true
      }
    ]
  },
  "assignedProvider": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "campaign": {
    "id": "<string>",
    "name": "<string>",
    "locationId": "<string>",
    "description": "<string>",
    "platformId": "<string>",
    "platformAssetId": "<string>",
    "externalCampaignId": "<string>",
    "externalResourceName": "<string>",
    "externalName": "<string>",
    "externalStatus": "<string>",
    "externalCurrency": "<string>",
    "externalDailyBudgetCents": 123,
    "externalLifetimeBudgetCents": 123,
    "externalLastSeenAt": "2023-11-07T05:31:56Z",
    "externalLastSyncedAt": "2023-11-07T05:31:56Z",
    "externalStaleAt": "2023-11-07T05:31:56Z",
    "externalSyncError": "<string>",
    "isActive": true,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "budgetCents": 123,
    "pipelineId": "<string>",
    "webhook": {
      "webhookKey": "<string>",
      "webhookUrl": "<string>",
      "redirectUrl": "<string>"
    },
    "createdDate": "2023-11-07T05:31:56Z",
    "updatedDate": "2023-11-07T05:31:56Z",
    "opportunityCount": 0,
    "convertedCount": 0
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Body

application/json

firstName

string

required

Minimum string length: 1

lastName

string | null

phoneNumber

string | null

sourceDetail

string | null

campaignId

string | null

locationId

string | null

patientId

string | null

pipelineId

string | null

currentStageId

string | null

assignedProviderId

string | null

notes

string | null

Response

Successful Response

string

required

firstName

string

required

pipelineId

string

required

patientId

string

required

stageEnteredAt

string<date-time>

required

lifecycleStage

enum<string>

required

Clinical vs marketing hygiene for a patient row.

Prospects are thin / pre-clinical people created by CRM capture. Transition is one-way to PATIENT on first completed visit, first committed payment, portal claim, or explicit staff action.

Available options:

PROSPECT,

PATIENT

lastName

string | null

phoneNumber

string | null

sourceDetail

string | null

campaignId

string | null

locationId

string | null

currentStageId

string | null

assignedProviderId

string | null

status

enum<string>

default:OPEN

Terminal-capable status for a pursuit episode (separate from stage).

Schema column lands with the opportunity rebuild; enum ships early so intake/services can type against it without a second enum PR.

Available options:

OPEN,

WON,

LOST,

DISQUALIFIED

wonAt

string<date-time> | null

lostAt

string<date-time> | null

lostReasonId

string | null

lostReasonLabel

string | null

convertedDate

string<date-time> | null

lostReason

string | null

sourceChannel

enum<string> | null

How a marketing interaction was observed.

Reporting dimension #1 on the touchpoint ledger. Add values only with a writer in the same PR (TypedEnum decodes unmapped strings to None).

Available options:

META_LEAD_FORM,

GOOGLE_LEAD_FORM,

PAID_CLICK,

WEB_ORGANIC,

WEB_FORM,

WEB_CHAT,

PHONE_CALL,

SMS_INBOUND,

EMAIL_INBOUND,

DM_INSTAGRAM,

DM_FACEBOOK,

REFERRAL,

WALK_IN,

QR,

IMPORT,

OTHER

originatingTouchpointId

string | null

estValueCents

integer | null

contactAttempts

integer

default:0

firstResponseDueAt

string<date-time> | null

firstResponseAt

string<date-time> | null

lastEngagedAt

string<date-time> | null

automationsPaused

boolean

default:false

stale

boolean

default:false

isExistingPatient

boolean

default:false

latestBooking

OpportunityBookingSummary · object | null

One real appointment fact visible in an opportunity's patient context.

Show child attributes

createdDate

string<date-time> | null

updatedDate

string<date-time> | null

currentStage

PipelineStageSummary · object | null

Show child attributes

assignedProvider

ProviderTiny · object | null

Show child attributes

campaign

CampaignSummary · object | null

Show child attributes

Bulk Create Opportunities Delete Opportunity

Getting Started

API Guides

Patient Management

Billing & Payments

Catalog & Inventory

Growth

Clinical & Scheduling

Platform

Create Opportunity

Headers

Body

Response