サブアカウント
顧客に代わって送信するプラットフォームは、顧客ごとにサブアカウントを作成します。これは独自の送信者、テンプレート、メッセージ、レポートを持つ別の Oblic 組織です。対象を指定すると、ご自身のキーでその組織を代理操作できます。サブアカウントの管理には accounts:manage を持つ Owner または Admin キーが必要です。
POST/external/v1/accounts
サブアカウントを作成する
- 名前
name- タイプ
- string
- 説明
必須。顧客名を 511 文字以内で指定します。
- 名前
externalId- タイプ
- string
- 説明
必須。ご自身のシステムの顧客 ID を、ASCII の英字、数字、
_、.、:、-の 100 文字以内で指定します。以後、この値でサブアカウントを識別します。
- 名前
issueKey- タイプ
- boolean
- 説明
サブアカウント専用の API キーを発行するかどうか。既定値は
trueです。
サブアカウントを作成する
curl -X POST https://api.oblic.app/external/v1/accounts \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{ "name": "Asha Textiles", "externalId": "tenant-4821" }'
レスポンス
{
"status": "success",
"data": {
"id": "ORG000R7ZM4Q2VXH00",
"name": "Asha Textiles",
"externalId": "tenant-4821",
"active": true,
"createdAt": "2026-10-24T09:30:00Z",
"apiKey": "obl_live_…"
},
"errors": null
}
apiKeyはこのレスポンスでのみ表示されます。その場で保存するか、再度サブアカウントを作成して別のキーを取得してください。従来の既定スコープを持つ User キーであり、events:writeは含まれません。送信、読み取り、送信者 ID と連絡先リストの管理はできますが、Owner または Admin キーが必要なルートは呼び出せません。- 同じ
externalIdを再指定すると 同じサブアカウントが返され、無効だった場合は再度有効になります。名前は変わりません。issueKeyがfalseでなければ呼び出すたびに別のキーが発行されます。無効化時に失効したものを除き、以前のキーも引き続き使用できます。 - サブアカウントの下にサブアカウントは作れません。 サブアカウントの代理操作中に作成すると
403 SUB_ACCOUNT_NOT_ALLOWEDが返されます。
GET/external/v1/accounts
サブアカウントを一覧表示する
無効なものも含むすべてのサブアカウントを作成順に返します。無効な場合は active が false です。一覧にキーは含まれません。
DELETE/external/v1/accounts/{accountId}
サブアカウントを無効にする
Oblic の id でサブアカウントを無効化します。ご自身の externalId ではありません。同時にすべてのキーを失効させます。同じ externalId で再作成すると再度有効になります。組織に属さないサブアカウントには 404 ACCOUNT_NOT_FOUND が返されます。
サブアカウントを代理操作する
X-Oblic-On-Behalf-Of にサブアカウントの externalId を指定すると、そのサブアカウントのキーを使った場合と同様にリクエストが実行されます。1 つのキーで全顧客を操作できるため、顧客ごとにキーを保持する必要はありません。
顧客のアカウントから送信する
curl -X POST https://api.oblic.app/external/v1/messages/email \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'X-Oblic-On-Behalf-Of: tenant-4821' \
-H 'Content-Type: application/json' \
-d '{ "from": "hello@ashatextiles.example", "to": ["asha@example.org"], "subject": "Welcome", "html": "<p>Welcome!</p>" }'
- サブアカウント固有のもの: メールはそのサブアカウントの送信者 IDからのみ送信されます。メッセージ、レポート、テンプレート、Webhook、
Idempotency-Keyの値も個別です。 - ご自身の組織に属するもの: メッセージ料金はご自身の組織のウォレットから支払われ、代理リクエストにはご自身の IP 許可リストが適用されます。
- 使用するキーのロールが適用されます。 顧客のテンプレート、Webhook、WhatsApp 番号を管理する場合は、ご自身の Owner または Admin キーとこのヘッダーを使用してください。
- 有効なサブアカウントに対応しない
externalIdには404 ACCOUNT_NOT_FOUNDが返されます。 - サブアカウントの Webhook イベント は独自のエンドポイントがあればそこへ、なければご自身のエンドポイントへ送信されます。その
externalIdは各イベントのaccountに含まれます。Webhookを参照してください。 - サブアカウントが送信する SMS テンプレート は、ご自身が共有したものです。テンプレートを参照してください。