Send an intake form

POST

intake_form_invitations

Send an intake form

curl --request POST \
  --url https://api.slant.app/v1/intake_form_invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "book_id": "<string>",
  "intake_form_id": "<string>",
  "household_id": "<string>",
  "recipients": {
    "head_of_household": "to",
    "spouse_or_partner": "none"
  },
  "creator_copy_method": "bcc",
  "reminder_limit": 3,
  "reminder_interval_days": 3,
  "prefill_answers": {}
}
'

import requests

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

payload = {
    "book_id": "<string>",
    "intake_form_id": "<string>",
    "household_id": "<string>",
    "recipients": {
        "head_of_household": "to",
        "spouse_or_partner": "none"
    },
    "creator_copy_method": "bcc",
    "reminder_limit": 3,
    "reminder_interval_days": 3,
    "prefill_answers": {}
}
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: '<string>',
    intake_form_id: '<string>',
    household_id: '<string>',
    recipients: {head_of_household: 'to', spouse_or_partner: 'none'},
    creator_copy_method: 'bcc',
    reminder_limit: 3,
    reminder_interval_days: 3,
    prefill_answers: {}
  })
};

fetch('https://api.slant.app/v1/intake_form_invitations', 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/intake_form_invitations",
  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' => '<string>',
    'intake_form_id' => '<string>',
    'household_id' => '<string>',
    'recipients' => [
        'head_of_household' => 'to',
        'spouse_or_partner' => 'none'
    ],
    'creator_copy_method' => 'bcc',
    'reminder_limit' => 3,
    'reminder_interval_days' => 3,
    'prefill_answers' => [
        
    ]
  ]),
  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/intake_form_invitations"

	payload := strings.NewReader("{\n  \"book_id\": \"<string>\",\n  \"intake_form_id\": \"<string>\",\n  \"household_id\": \"<string>\",\n  \"recipients\": {\n    \"head_of_household\": \"to\",\n    \"spouse_or_partner\": \"none\"\n  },\n  \"creator_copy_method\": \"bcc\",\n  \"reminder_limit\": 3,\n  \"reminder_interval_days\": 3,\n  \"prefill_answers\": {}\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/intake_form_invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"book_id\": \"<string>\",\n  \"intake_form_id\": \"<string>\",\n  \"household_id\": \"<string>\",\n  \"recipients\": {\n    \"head_of_household\": \"to\",\n    \"spouse_or_partner\": \"none\"\n  },\n  \"creator_copy_method\": \"bcc\",\n  \"reminder_limit\": 3,\n  \"reminder_interval_days\": 3,\n  \"prefill_answers\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"<string>\",\n  \"intake_form_id\": \"<string>\",\n  \"household_id\": \"<string>\",\n  \"recipients\": {\n    \"head_of_household\": \"to\",\n    \"spouse_or_partner\": \"none\"\n  },\n  \"creator_copy_method\": \"bcc\",\n  \"reminder_limit\": 3,\n  \"reminder_interval_days\": 3,\n  \"prefill_answers\": {}\n}"

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

{
  "id": "invitation123xyz",
  "book_id": "book123xyz",
  "intake_form_id": "form123xyz",
  "household_id": "household123xyz",
  "state": "open",
  "delivery_method": "slant_email",
  "creator_copy_method": "bcc",
  "sent_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

OAuth access token or Slant personal access token (slnt_pat_...). Read-only personal tokens allow GET requests only.

Headers

Idempotency-Key

string

Unique key to ensure idempotent request handling.

Body

application/json

book_id

string

required

The book ID

intake_form_id

string

required

The published intake form ID

household_id

string

required

The client or prospect household ID

recipients

object

Recipient delivery types by household role

Show child attributes

creator_copy_method

enum<string>

default:bcc

Available options:

bcc,

cc,

none

reminder_limit

integer

default:3

Required range: 0 <= x <= 10

reminder_interval_days

integer

default:3

Required range: 1 <= x <= 30

prefill_answers

object

Optional values keyed by editable field keys from the latest published field definitions. Overrides automatic prefill for supplied fields; omitted fields keep automatic prefill. Null clears a field. Unknown keys, invalid values, files, calculations, acknowledgments, and booking controls return 422. Values are not returned.

Response

intake form invitation queued

string

required

The intake form invitation ID

Example:

"invitation123xyz"

book_id

string

required

The book ID

Example:

"book123xyz"

intake_form_id

string

required

The intake form ID

Example:

"form123xyz"

household_id

string

required

The recipient household ID

Example:

"household123xyz"

state

enum<string>

required

Available options:

open,

submitted,

expired,

revoked

delivery_method

enum<string>

required

Available options:

slant_email

creator_copy_method

enum<string>

required

Available options:

bcc,

cc,

none

sent_at

string<date-time>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

⌘I

Send an intake form

curl --request POST \
  --url https://api.slant.app/v1/intake_form_invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "book_id": "<string>",
  "intake_form_id": "<string>",
  "household_id": "<string>",
  "recipients": {
    "head_of_household": "to",
    "spouse_or_partner": "none"
  },
  "creator_copy_method": "bcc",
  "reminder_limit": 3,
  "reminder_interval_days": 3,
  "prefill_answers": {}
}
'

import requests

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

payload = {
    "book_id": "<string>",
    "intake_form_id": "<string>",
    "household_id": "<string>",
    "recipients": {
        "head_of_household": "to",
        "spouse_or_partner": "none"
    },
    "creator_copy_method": "bcc",
    "reminder_limit": 3,
    "reminder_interval_days": 3,
    "prefill_answers": {}
}
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: '<string>',
    intake_form_id: '<string>',
    household_id: '<string>',
    recipients: {head_of_household: 'to', spouse_or_partner: 'none'},
    creator_copy_method: 'bcc',
    reminder_limit: 3,
    reminder_interval_days: 3,
    prefill_answers: {}
  })
};

fetch('https://api.slant.app/v1/intake_form_invitations', 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/intake_form_invitations",
  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' => '<string>',
    'intake_form_id' => '<string>',
    'household_id' => '<string>',
    'recipients' => [
        'head_of_household' => 'to',
        'spouse_or_partner' => 'none'
    ],
    'creator_copy_method' => 'bcc',
    'reminder_limit' => 3,
    'reminder_interval_days' => 3,
    'prefill_answers' => [
        
    ]
  ]),
  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/intake_form_invitations"

	payload := strings.NewReader("{\n  \"book_id\": \"<string>\",\n  \"intake_form_id\": \"<string>\",\n  \"household_id\": \"<string>\",\n  \"recipients\": {\n    \"head_of_household\": \"to\",\n    \"spouse_or_partner\": \"none\"\n  },\n  \"creator_copy_method\": \"bcc\",\n  \"reminder_limit\": 3,\n  \"reminder_interval_days\": 3,\n  \"prefill_answers\": {}\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/intake_form_invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"book_id\": \"<string>\",\n  \"intake_form_id\": \"<string>\",\n  \"household_id\": \"<string>\",\n  \"recipients\": {\n    \"head_of_household\": \"to\",\n    \"spouse_or_partner\": \"none\"\n  },\n  \"creator_copy_method\": \"bcc\",\n  \"reminder_limit\": 3,\n  \"reminder_interval_days\": 3,\n  \"prefill_answers\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"<string>\",\n  \"intake_form_id\": \"<string>\",\n  \"household_id\": \"<string>\",\n  \"recipients\": {\n    \"head_of_household\": \"to\",\n    \"spouse_or_partner\": \"none\"\n  },\n  \"creator_copy_method\": \"bcc\",\n  \"reminder_limit\": 3,\n  \"reminder_interval_days\": 3,\n  \"prefill_answers\": {}\n}"

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

{
  "id": "invitation123xyz",
  "book_id": "book123xyz",
  "intake_form_id": "form123xyz",
  "household_id": "household123xyz",
  "state": "open",
  "delivery_method": "slant_email",
  "creator_copy_method": "bcc",
  "sent_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Getting started

Endpoints

Webhooks

Authorizations

Headers

Body

Response