Create an opportunity

POST

opportunities

curl --request POST \
  --url https://api.slant.app/v1/opportunities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "book_id": "abc123xyz",
  "name": "New Investment Opportunity",
  "value": 500000,
  "probability": 75,
  "target_close_date": "2026-06-01T00:00:00Z",
  "pipeline_type": "prospect",
  "pipeline_id": "pipeline123xyz",
  "pipeline_stage_id": "stage123xyz",
  "household_id": "household123xyz",
  "opportunityable_type": "Contact",
  "opportunityable_id": "contact123xyz",
  "owner_id": "user123xyz",
  "assigned_to_id": "user123xyz"
}
'

import requests

url = "https://api.slant.app/v1/opportunities"

payload = {
    "book_id": "abc123xyz",
    "name": "New Investment Opportunity",
    "value": 500000,
    "probability": 75,
    "target_close_date": "2026-06-01T00:00:00Z",
    "pipeline_type": "prospect",
    "pipeline_id": "pipeline123xyz",
    "pipeline_stage_id": "stage123xyz",
    "household_id": "household123xyz",
    "opportunityable_type": "Contact",
    "opportunityable_id": "contact123xyz",
    "owner_id": "user123xyz",
    "assigned_to_id": "user123xyz"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    book_id: 'abc123xyz',
    name: 'New Investment Opportunity',
    value: 500000,
    probability: 75,
    target_close_date: '2026-06-01T00:00:00Z',
    pipeline_type: 'prospect',
    pipeline_id: 'pipeline123xyz',
    pipeline_stage_id: 'stage123xyz',
    household_id: 'household123xyz',
    opportunityable_type: 'Contact',
    opportunityable_id: 'contact123xyz',
    owner_id: 'user123xyz',
    assigned_to_id: 'user123xyz'
  })
};

fetch('https://api.slant.app/v1/opportunities', 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.slant.app/v1/opportunities",
  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([
    'book_id' => 'abc123xyz',
    'name' => 'New Investment Opportunity',
    'value' => 500000,
    'probability' => 75,
    'target_close_date' => '2026-06-01T00:00:00Z',
    'pipeline_type' => 'prospect',
    'pipeline_id' => 'pipeline123xyz',
    'pipeline_stage_id' => 'stage123xyz',
    'household_id' => 'household123xyz',
    'opportunityable_type' => 'Contact',
    'opportunityable_id' => 'contact123xyz',
    'owner_id' => 'user123xyz',
    'assigned_to_id' => 'user123xyz'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.slant.app/v1/opportunities"

	payload := strings.NewReader("{\n  \"book_id\": \"abc123xyz\",\n  \"name\": \"New Investment Opportunity\",\n  \"value\": 500000,\n  \"probability\": 75,\n  \"target_close_date\": \"2026-06-01T00:00:00Z\",\n  \"pipeline_type\": \"prospect\",\n  \"pipeline_id\": \"pipeline123xyz\",\n  \"pipeline_stage_id\": \"stage123xyz\",\n  \"household_id\": \"household123xyz\",\n  \"opportunityable_type\": \"Contact\",\n  \"opportunityable_id\": \"contact123xyz\",\n  \"owner_id\": \"user123xyz\",\n  \"assigned_to_id\": \"user123xyz\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.slant.app/v1/opportunities")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"book_id\": \"abc123xyz\",\n  \"name\": \"New Investment Opportunity\",\n  \"value\": 500000,\n  \"probability\": 75,\n  \"target_close_date\": \"2026-06-01T00:00:00Z\",\n  \"pipeline_type\": \"prospect\",\n  \"pipeline_id\": \"pipeline123xyz\",\n  \"pipeline_stage_id\": \"stage123xyz\",\n  \"household_id\": \"household123xyz\",\n  \"opportunityable_type\": \"Contact\",\n  \"opportunityable_id\": \"contact123xyz\",\n  \"owner_id\": \"user123xyz\",\n  \"assigned_to_id\": \"user123xyz\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.slant.app/v1/opportunities")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"book_id\": \"abc123xyz\",\n  \"name\": \"New Investment Opportunity\",\n  \"value\": 500000,\n  \"probability\": 75,\n  \"target_close_date\": \"2026-06-01T00:00:00Z\",\n  \"pipeline_type\": \"prospect\",\n  \"pipeline_id\": \"pipeline123xyz\",\n  \"pipeline_stage_id\": \"stage123xyz\",\n  \"household_id\": \"household123xyz\",\n  \"opportunityable_type\": \"Contact\",\n  \"opportunityable_id\": \"contact123xyz\",\n  \"owner_id\": \"user123xyz\",\n  \"assigned_to_id\": \"user123xyz\"\n}"

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

{
  "id": "abc123xyz",
  "name": "New Investment Opportunity",
  "book_id": "book123xyz",
  "pipeline": {
    "id": "pipeline123xyz",
    "name": "Sales Pipeline",
    "audience_types": [],
    "pipeline_type": "prospect",
    "default_pipeline_types": [],
    "book_id": "book123xyz",
    "pipeline_stages": [
      {
        "id": "stage123xyz",
        "name": "Qualified",
        "stage_order": 1,
        "visible": true,
        "default_probability": 50
      }
    ]
  },
  "pipeline_stage": {
    "id": "stage123xyz",
    "name": "Qualified",
    "stage_order": 1,
    "visible": true,
    "default_probability": 50
  },
  "assigned_to": {
    "id": "abc123xyz",
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "api_access": {
      "auth_type": "personal_access_token",
      "scope": "read_write"
    }
  },
  "value": 5000,
  "probability": 75,
  "target_close_date": "2023-11-07T05:31:56Z",
  "stage_updated_at": "2023-11-07T05:31:56Z",
  "household_id": "household123xyz",
  "opportunityable_id": "<string>",
  "opportunityable": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>"
  },
  "custom_fields": {
    "lead_source": "Referral"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "invalid_json",
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Idempotency-Key

string

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Body

application/json

Opportunity data. Provide pipeline_id or pipeline_type to choose a pipeline. Household-backed opportunities can omit both and Slant will infer the default client/prospect pipeline from the household type. Contact and business opportunities must provide a compatible pipeline_id, or a pipeline_type whose default pipeline supports that related record type.

book_id

string

required

The book ID

Example:

"abc123xyz"

name

string

required

Name of the opportunity

Example:

"New Investment Opportunity"

value

integer

The monetary value of the opportunity in whole dollars, not cents

Example:

500000

probability

integer

The probability of closing (0-100)

Example:

75

target_close_date

string<date-time>

Expected close date (must be in the future)

Example:

"2026-06-01T00:00:00Z"

pipeline_type

enum<string>

The pipeline type used to choose the default prospect or client pipeline when pipeline_id is not provided.

Available options:

prospect,

client

Example:

"prospect"

pipeline_id

string

The exact pipeline ID to create the opportunity in. Takes precedence over pipeline_type.

Example:

"pipeline123xyz"

pipeline_stage_id

string

The pipeline stage ID. Must belong to the selected pipeline. Defaults to the first stage.

Example:

"stage123xyz"

household_id

string

Legacy household ID for household-backed opportunities (optional)

Example:

"household123xyz"

opportunityable_type

enum<string>

Related record type for the opportunity. Household records can infer the default client/prospect pipeline; Contact and Business records need a compatible pipeline_id or pipeline_type.

Available options:

Household,

Contact,

Business

Example:

"Contact"

opportunityable_id

string

Related record ID for the opportunity

Example:

"contact123xyz"

owner_id

string

Alias for assigned_to_id

Example:

"user123xyz"

assigned_to_id

string

The assigned user ID from the relevant book users list (defaults to authenticated user)

Example:

"user123xyz"

Response

opportunity created

string

required

The opportunity ID

Example:

"abc123xyz"

name

string

required

The name of the opportunity

Example:

"New Investment Opportunity"

book_id

string

required

The book ID

Example:

"book123xyz"

pipeline

object

required

Show child attributes

pipeline_stage

object

required

Show child attributes

assigned_to

object

required

The user assigned to this opportunity. Set this with assigned_to_id on create or update.

Show child attributes

value

integer | null

The monetary value of the opportunity in dollars

Example:

5000

probability

integer | null

The probability of closing (0-100)

Example:

75

target_close_date

string<date-time> | null

Expected close date

stage_updated_at

string<date-time> | null

When the opportunity last moved stages. Useful for stage aging and pipeline reporting.

household_id

string | null

The household ID (null for unassociated opportunities)

Example:

"household123xyz"

opportunityable_type

enum<string> | null

The related record type for this opportunity

Available options:

Household,

Contact,

Business

opportunityable_id

string | null

The related record ID for this opportunity

opportunityable

object | null

Compact related record payload for the opportunity

Show child attributes

custom_fields

object

Custom field values as key-value pairs

Example:

{ "lead_source": "Referral" }

created_at

string<date-time>

When the opportunity was created

updated_at

string<date-time>

When the opportunity was last updated

⌘I

Create an opportunity

curl --request POST \
  --url https://api.slant.app/v1/opportunities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "book_id": "abc123xyz",
  "name": "New Investment Opportunity",
  "value": 500000,
  "probability": 75,
  "target_close_date": "2026-06-01T00:00:00Z",
  "pipeline_type": "prospect",
  "pipeline_id": "pipeline123xyz",
  "pipeline_stage_id": "stage123xyz",
  "household_id": "household123xyz",
  "opportunityable_type": "Contact",
  "opportunityable_id": "contact123xyz",
  "owner_id": "user123xyz",
  "assigned_to_id": "user123xyz"
}
'

import requests

url = "https://api.slant.app/v1/opportunities"

payload = {
    "book_id": "abc123xyz",
    "name": "New Investment Opportunity",
    "value": 500000,
    "probability": 75,
    "target_close_date": "2026-06-01T00:00:00Z",
    "pipeline_type": "prospect",
    "pipeline_id": "pipeline123xyz",
    "pipeline_stage_id": "stage123xyz",
    "household_id": "household123xyz",
    "opportunityable_type": "Contact",
    "opportunityable_id": "contact123xyz",
    "owner_id": "user123xyz",
    "assigned_to_id": "user123xyz"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    book_id: 'abc123xyz',
    name: 'New Investment Opportunity',
    value: 500000,
    probability: 75,
    target_close_date: '2026-06-01T00:00:00Z',
    pipeline_type: 'prospect',
    pipeline_id: 'pipeline123xyz',
    pipeline_stage_id: 'stage123xyz',
    household_id: 'household123xyz',
    opportunityable_type: 'Contact',
    opportunityable_id: 'contact123xyz',
    owner_id: 'user123xyz',
    assigned_to_id: 'user123xyz'
  })
};

fetch('https://api.slant.app/v1/opportunities', 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.slant.app/v1/opportunities",
  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([
    'book_id' => 'abc123xyz',
    'name' => 'New Investment Opportunity',
    'value' => 500000,
    'probability' => 75,
    'target_close_date' => '2026-06-01T00:00:00Z',
    'pipeline_type' => 'prospect',
    'pipeline_id' => 'pipeline123xyz',
    'pipeline_stage_id' => 'stage123xyz',
    'household_id' => 'household123xyz',
    'opportunityable_type' => 'Contact',
    'opportunityable_id' => 'contact123xyz',
    'owner_id' => 'user123xyz',
    'assigned_to_id' => 'user123xyz'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.slant.app/v1/opportunities"

	payload := strings.NewReader("{\n  \"book_id\": \"abc123xyz\",\n  \"name\": \"New Investment Opportunity\",\n  \"value\": 500000,\n  \"probability\": 75,\n  \"target_close_date\": \"2026-06-01T00:00:00Z\",\n  \"pipeline_type\": \"prospect\",\n  \"pipeline_id\": \"pipeline123xyz\",\n  \"pipeline_stage_id\": \"stage123xyz\",\n  \"household_id\": \"household123xyz\",\n  \"opportunityable_type\": \"Contact\",\n  \"opportunityable_id\": \"contact123xyz\",\n  \"owner_id\": \"user123xyz\",\n  \"assigned_to_id\": \"user123xyz\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.slant.app/v1/opportunities")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"book_id\": \"abc123xyz\",\n  \"name\": \"New Investment Opportunity\",\n  \"value\": 500000,\n  \"probability\": 75,\n  \"target_close_date\": \"2026-06-01T00:00:00Z\",\n  \"pipeline_type\": \"prospect\",\n  \"pipeline_id\": \"pipeline123xyz\",\n  \"pipeline_stage_id\": \"stage123xyz\",\n  \"household_id\": \"household123xyz\",\n  \"opportunityable_type\": \"Contact\",\n  \"opportunityable_id\": \"contact123xyz\",\n  \"owner_id\": \"user123xyz\",\n  \"assigned_to_id\": \"user123xyz\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.slant.app/v1/opportunities")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"book_id\": \"abc123xyz\",\n  \"name\": \"New Investment Opportunity\",\n  \"value\": 500000,\n  \"probability\": 75,\n  \"target_close_date\": \"2026-06-01T00:00:00Z\",\n  \"pipeline_type\": \"prospect\",\n  \"pipeline_id\": \"pipeline123xyz\",\n  \"pipeline_stage_id\": \"stage123xyz\",\n  \"household_id\": \"household123xyz\",\n  \"opportunityable_type\": \"Contact\",\n  \"opportunityable_id\": \"contact123xyz\",\n  \"owner_id\": \"user123xyz\",\n  \"assigned_to_id\": \"user123xyz\"\n}"

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

{
  "id": "abc123xyz",
  "name": "New Investment Opportunity",
  "book_id": "book123xyz",
  "pipeline": {
    "id": "pipeline123xyz",
    "name": "Sales Pipeline",
    "audience_types": [],
    "pipeline_type": "prospect",
    "default_pipeline_types": [],
    "book_id": "book123xyz",
    "pipeline_stages": [
      {
        "id": "stage123xyz",
        "name": "Qualified",
        "stage_order": 1,
        "visible": true,
        "default_probability": 50
      }
    ]
  },
  "pipeline_stage": {
    "id": "stage123xyz",
    "name": "Qualified",
    "stage_order": 1,
    "visible": true,
    "default_probability": 50
  },
  "assigned_to": {
    "id": "abc123xyz",
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "api_access": {
      "auth_type": "personal_access_token",
      "scope": "read_write"
    }
  },
  "value": 5000,
  "probability": 75,
  "target_close_date": "2023-11-07T05:31:56Z",
  "stage_updated_at": "2023-11-07T05:31:56Z",
  "household_id": "household123xyz",
  "opportunityable_id": "<string>",
  "opportunityable": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>"
  },
  "custom_fields": {
    "lead_source": "Referral"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "invalid_json",
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Getting started

Endpoints

Create an opportunity

Authorizations

Headers

Body

Response