curl --request POST \
  --url https://sandbox.api.meet-oj.com/partner/v0/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "Acme Listings in-app inbox",
  "policy": {
    "allow": [],
    "quiet_hours": {
      "start": "21:00",
      "end": "08:00",
      "timezone": "America/Chicago"
    },
    "max_per_day": 123
  },
  "delivery": {
    "url": "<string>",
    "provider": "twilio",
    "account_sid": "<string>",
    "auth_token": "<string>",
    "from_number": "<string>",
    "business_id": "<string>",
    "csp_token": "<string>",
    "from_address": "jsmith@example.com"
  }
}
'

import requests

url = "https://sandbox.api.meet-oj.com/partner/v0/channels"

payload = {
    "name": "Acme Listings in-app inbox",
    "policy": {
        "allow": [],
        "quiet_hours": {
            "start": "21:00",
            "end": "08:00",
            "timezone": "America/Chicago"
        },
        "max_per_day": 123
    },
    "delivery": {
        "url": "<string>",
        "provider": "twilio",
        "account_sid": "<string>",
        "auth_token": "<string>",
        "from_number": "<string>",
        "business_id": "<string>",
        "csp_token": "<string>",
        "from_address": "jsmith@example.com"
    }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Acme Listings in-app inbox',
    policy: {
      allow: [],
      quiet_hours: {start: '21:00', end: '08:00', timezone: 'America/Chicago'},
      max_per_day: 123
    },
    delivery: {
      url: '<string>',
      provider: 'twilio',
      account_sid: '<string>',
      auth_token: '<string>',
      from_number: '<string>',
      business_id: '<string>',
      csp_token: '<string>',
      from_address: 'jsmith@example.com'
    }
  })
};

fetch('https://sandbox.api.meet-oj.com/partner/v0/channels', 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://sandbox.api.meet-oj.com/partner/v0/channels",
  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([
    'name' => 'Acme Listings in-app inbox',
    'policy' => [
        'allow' => [
                
        ],
        'quiet_hours' => [
                'start' => '21:00',
                'end' => '08:00',
                'timezone' => 'America/Chicago'
        ],
        'max_per_day' => 123
    ],
    'delivery' => [
        'url' => '<string>',
        'provider' => 'twilio',
        'account_sid' => '<string>',
        'auth_token' => '<string>',
        'from_number' => '<string>',
        'business_id' => '<string>',
        'csp_token' => '<string>',
        'from_address' => 'jsmith@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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://sandbox.api.meet-oj.com/partner/v0/channels"

	payload := strings.NewReader("{\n  \"name\": \"Acme Listings in-app inbox\",\n  \"policy\": {\n    \"allow\": [],\n    \"quiet_hours\": {\n      \"start\": \"21:00\",\n      \"end\": \"08:00\",\n      \"timezone\": \"America/Chicago\"\n    },\n    \"max_per_day\": 123\n  },\n  \"delivery\": {\n    \"url\": \"<string>\",\n    \"provider\": \"twilio\",\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\",\n    \"from_number\": \"<string>\",\n    \"business_id\": \"<string>\",\n    \"csp_token\": \"<string>\",\n    \"from_address\": \"jsmith@example.com\"\n  }\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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://sandbox.api.meet-oj.com/partner/v0/channels")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Listings in-app inbox\",\n  \"policy\": {\n    \"allow\": [],\n    \"quiet_hours\": {\n      \"start\": \"21:00\",\n      \"end\": \"08:00\",\n      \"timezone\": \"America/Chicago\"\n    },\n    \"max_per_day\": 123\n  },\n  \"delivery\": {\n    \"url\": \"<string>\",\n    \"provider\": \"twilio\",\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\",\n    \"from_number\": \"<string>\",\n    \"business_id\": \"<string>\",\n    \"csp_token\": \"<string>\",\n    \"from_address\": \"jsmith@example.com\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.meet-oj.com/partner/v0/channels")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Listings in-app inbox\",\n  \"policy\": {\n    \"allow\": [],\n    \"quiet_hours\": {\n      \"start\": \"21:00\",\n      \"end\": \"08:00\",\n      \"timezone\": \"America/Chicago\"\n    },\n    \"max_per_day\": 123\n  },\n  \"delivery\": {\n    \"url\": \"<string>\",\n    \"provider\": \"twilio\",\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\",\n    \"from_number\": \"<string>\",\n    \"business_id\": \"<string>\",\n    \"csp_token\": \"<string>\",\n    \"from_address\": \"jsmith@example.com\"\n  }\n}"

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

{
  "id": "chn_01K5X7A1B2",
  "type": "webhook",
  "name": "<string>",
  "status": "active",
  "policy": {
    "allow": [
      "status_updates"
    ],
    "quiet_hours": {
      "start": "21:00",
      "end": "08:00",
      "timezone": "America/Chicago"
    },
    "max_per_day": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "object": "channel_connector",
  "delivery": {
    "url": "<string>",
    "from_number": "<string>",
    "from_address": "<string>",
    "provider": "<string>"
  }
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

Channels

Register a channel connector

Registers a channel you own so O.J. can reach your borrowers through it. Four types are supported.

webhook: O.J. POSTs each borrower-facing message to a URL on your server, signed like any webhook, and your product shows it in its own inbox or chat. This is the simplest type.
sms: your Twilio (or compatible) account. O.J. sends texts from your number.
apple_business_messages: your Apple Business Messages account. O.J. replies in iMessage as you.
email: your sending domain. O.J. emails from an address you choose.

Credentials are stored encrypted and never returned. The policy says what O.J. may send through the connector and when. A connector with an empty policy sends nothing.

POST

channels

curl --request POST \
  --url https://sandbox.api.meet-oj.com/partner/v0/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "Acme Listings in-app inbox",
  "policy": {
    "allow": [],
    "quiet_hours": {
      "start": "21:00",
      "end": "08:00",
      "timezone": "America/Chicago"
    },
    "max_per_day": 123
  },
  "delivery": {
    "url": "<string>",
    "provider": "twilio",
    "account_sid": "<string>",
    "auth_token": "<string>",
    "from_number": "<string>",
    "business_id": "<string>",
    "csp_token": "<string>",
    "from_address": "jsmith@example.com"
  }
}
'

import requests

url = "https://sandbox.api.meet-oj.com/partner/v0/channels"

payload = {
    "name": "Acme Listings in-app inbox",
    "policy": {
        "allow": [],
        "quiet_hours": {
            "start": "21:00",
            "end": "08:00",
            "timezone": "America/Chicago"
        },
        "max_per_day": 123
    },
    "delivery": {
        "url": "<string>",
        "provider": "twilio",
        "account_sid": "<string>",
        "auth_token": "<string>",
        "from_number": "<string>",
        "business_id": "<string>",
        "csp_token": "<string>",
        "from_address": "jsmith@example.com"
    }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Acme Listings in-app inbox',
    policy: {
      allow: [],
      quiet_hours: {start: '21:00', end: '08:00', timezone: 'America/Chicago'},
      max_per_day: 123
    },
    delivery: {
      url: '<string>',
      provider: 'twilio',
      account_sid: '<string>',
      auth_token: '<string>',
      from_number: '<string>',
      business_id: '<string>',
      csp_token: '<string>',
      from_address: 'jsmith@example.com'
    }
  })
};

fetch('https://sandbox.api.meet-oj.com/partner/v0/channels', 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://sandbox.api.meet-oj.com/partner/v0/channels",
  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([
    'name' => 'Acme Listings in-app inbox',
    'policy' => [
        'allow' => [
                
        ],
        'quiet_hours' => [
                'start' => '21:00',
                'end' => '08:00',
                'timezone' => 'America/Chicago'
        ],
        'max_per_day' => 123
    ],
    'delivery' => [
        'url' => '<string>',
        'provider' => 'twilio',
        'account_sid' => '<string>',
        'auth_token' => '<string>',
        'from_number' => '<string>',
        'business_id' => '<string>',
        'csp_token' => '<string>',
        'from_address' => 'jsmith@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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://sandbox.api.meet-oj.com/partner/v0/channels"

	payload := strings.NewReader("{\n  \"name\": \"Acme Listings in-app inbox\",\n  \"policy\": {\n    \"allow\": [],\n    \"quiet_hours\": {\n      \"start\": \"21:00\",\n      \"end\": \"08:00\",\n      \"timezone\": \"America/Chicago\"\n    },\n    \"max_per_day\": 123\n  },\n  \"delivery\": {\n    \"url\": \"<string>\",\n    \"provider\": \"twilio\",\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\",\n    \"from_number\": \"<string>\",\n    \"business_id\": \"<string>\",\n    \"csp_token\": \"<string>\",\n    \"from_address\": \"jsmith@example.com\"\n  }\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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://sandbox.api.meet-oj.com/partner/v0/channels")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Listings in-app inbox\",\n  \"policy\": {\n    \"allow\": [],\n    \"quiet_hours\": {\n      \"start\": \"21:00\",\n      \"end\": \"08:00\",\n      \"timezone\": \"America/Chicago\"\n    },\n    \"max_per_day\": 123\n  },\n  \"delivery\": {\n    \"url\": \"<string>\",\n    \"provider\": \"twilio\",\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\",\n    \"from_number\": \"<string>\",\n    \"business_id\": \"<string>\",\n    \"csp_token\": \"<string>\",\n    \"from_address\": \"jsmith@example.com\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.meet-oj.com/partner/v0/channels")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Listings in-app inbox\",\n  \"policy\": {\n    \"allow\": [],\n    \"quiet_hours\": {\n      \"start\": \"21:00\",\n      \"end\": \"08:00\",\n      \"timezone\": \"America/Chicago\"\n    },\n    \"max_per_day\": 123\n  },\n  \"delivery\": {\n    \"url\": \"<string>\",\n    \"provider\": \"twilio\",\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\",\n    \"from_number\": \"<string>\",\n    \"business_id\": \"<string>\",\n    \"csp_token\": \"<string>\",\n    \"from_address\": \"jsmith@example.com\"\n  }\n}"

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

{
  "id": "chn_01K5X7A1B2",
  "type": "webhook",
  "name": "<string>",
  "status": "active",
  "policy": {
    "allow": [
      "status_updates"
    ],
    "quiet_hours": {
      "start": "21:00",
      "end": "08:00",
      "timezone": "America/Chicago"
    },
    "max_per_day": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "object": "channel_connector",
  "delivery": {
    "url": "<string>",
    "from_number": "<string>",
    "from_address": "<string>",
    "provider": "<string>"
  }
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

Authorizations

Authorization

string

header

required

One client per partner per environment. Access tokens expire after 15 minutes. Scopes are granted per client. Sandbox clients use https://sandbox.api.meet-oj.com/oauth/token.

Headers

Idempotency-Key

string

required

IETF Idempotency-Key semantics (draft-ietf-httpapi-idempotency-key-header). Send a fresh unique value (a UUID) with every new request. A retry with the same key and the same payload returns the original response with the header Idempotent-Replayed: true. The same key with a different payload is rejected with 422 and code idempotency_key_reused. Keys are kept for 24 hours.

Maximum string length: 255

Body

application/json

The body for registering a channel you own. Which fields of delivery are read depends on type.

type

enum<string>

required

Available options:

webhook,

sms,

apple_business_messages,

email

name

string

required

Example:

"Acme Listings in-app inbox"

policy

object

required

What O.J. may send through a connector, and when. A connector with an empty allow list sends nothing.

Show child attributes

delivery

object

How O.J. delivers. For webhook: url. For sms: provider, account_sid, auth_token, from_number. For apple_business_messages: business_id, csp_token. For email: from_address, plus DNS records O.J. gives you to verify the domain.

Show child attributes

Response

Connector registered

A channel you registered. Credentials are never returned. delivery shows only the non-secret fields.

string

required

Example:

"chn_01K5X7A1B2"

type

enum<string>

required

Available options:

webhook,

sms,

apple_business_messages,

email

name

string

required

status

enum<string>

required

verifying while a domain or number is being confirmed.

Available options:

active,

verifying,

disabled

policy

object

required

What O.J. may send through a connector, and when. A connector with an empty allow list sends nothing.

Show child attributes

created_at

string<date-time>

required

object

string

Allowed value: "channel_connector"

delivery

object

Show child attributes