API docs by Redocly

Jolt External API (1.0.0)

Download OpenAPI specification:

Jolt の外部 API。 認証には X-Jolt-API-Key ヘッダが必要です。

Referral

リード関連の操作

Lead ステータス更新

Referral Lead のステータスを更新する。 Lead の特定には lead_id または custom_field_id + custom_field_value のいずれか一方を指定する。 Vendor / VendorProgram の整合性が取れない場合は 404 を返す。

Authorizations:
apiKeyAuth
header Parameters
X-Dry-Run
string
Value: "true"
Example: true

true を指定すると、認証およびリクエストバリデーションのみ実行し、 DB操作をスキップして 200 OK を返す。疎通確認用。

Request Body schema: application/json
required
lead_id
string

Referral Lead ID（Jolt 内部 ID）

custom_field_id
string

カスタムフィールド ID（ULID）

custom_field_value
string

カスタムフィールドの値

status
required
string
Enum: "qualified" "unqualified" "won" "lost"

Lead ステータス。 qualified: 適格 unqualified: 不適格 won: 取引成立 lost: 取引不成立

status_detail
string or null

ステータス詳細。 unqualified / lost の場合のみ指定可能。

Responses

Request samples

Content type
application/json
Example
{
  • "lead_id": "01KB1S3TSZ4KMW6TR84KF6KPXC",
  • "status": "qualified"
}

Response samples

Content type
application/json
{ }

ReferralTransaction

取引レコードの操作

取引レコード作成

紹介された顧客に対する取引レコードを作成する。 顧客の特定には customer_id または custom_field_id + custom_field_value のいずれか一方を指定する。 作成後、顧客向け報酬作成メッセージを非同期で送信する。

Authorizations:
apiKeyAuth
header Parameters
X-Dry-Run
string
Value: "true"
Example: true

true を指定すると、認証およびリクエストバリデーションのみ実行し、 DB操作をスキップして 200 OK を返す。疎通確認用。

Request Body schema: application/json
required
customer_id
string

Referral Customer ID（Jolt 内部 ID）

custom_field_id
string

カスタムフィールド ID（ULID）

custom_field_value
string

カスタムフィールドの値

sales_amount
required
integer <int32> >= 0

紹介売り上げ金額

Responses

Request samples

Content type
application/json
Example
{
  • "customer_id": "01KB1S3TSZ4KMW6TR84KF6KPXC",
  • "sales_amount": 50000
}

Response samples

Content type
application/json
{ }

ReferralCustomFieldValue

カスタムフィールド値の操作

カスタムフィールド値更新

指定した Referral のカスタムフィールド値を更新する。 部分更新をサポートし、指定されたフィールドのみ更新される。 存在しない値は新規作成、既存の値は上書きされる。

Authorizations:
apiKeyAuth
header Parameters
X-Dry-Run
string
Value: "true"
Example: true

true を指定すると、認証およびリクエストバリデーションのみ実行し、 DB操作をスキップして 200 OK を返す。疎通確認用。

Request Body schema: application/json
required
referral_id
required
string

Referral ID（ULID）

required
Array of objects

更新するカスタムフィールド値の配列

Responses

Request samples

Content type
application/json
{
  • "referral_id": "01KB1S3TSZ4KMW6TR84KF6KPXC",
  • "custom_field_values": [
    ]
}

Response samples

Content type
application/json
{ }

ReferralActivityLog

活動ログの操作

活動ログ作成

紹介に対する活動ログを作成する。 Vendor / VendorProgram の整合性が取れない場合は 404 を返す。

Authorizations:
apiKeyAuth
header Parameters
X-Dry-Run
string
Value: "true"
Example: true

true を指定すると、認証およびリクエストバリデーションのみ実行し、 DB操作をスキップして 200 OK を返す。疎通確認用。

Request Body schema: application/json
required
referral_id
required
string

Referral ID（ULID）

title
required
string

活動ログのタイトル

content
string

活動ログの内容

activity_date
required
string <date>

活動日（YYYY-MM-DD）

Responses

Request samples

Content type
application/json
{
  • "referral_id": "01KB1S3TSZ4KMW6TR84KF6KPXC",
  • "title": "初回訪問",
  • "content": "初回訪問を実施し、サービス概要を説明しました。",
  • "activity_date": "2025-06-15"
}

Response samples

Content type
application/json
{ }

WebhookEvents

登録された Webhook URL に送信されるイベントペイロード。 各イベントは共通の Envelope 構造でラップされ、type フィールドでイベント種別を識別できます。 Webhook 受信側は HTTP 200 を返却してください。

リード作成イベント

新しいリード（紹介案件）が作成された際に送信されるイベント。 type: "lead.created"

Request Body schema: application/json
required
id
required
string

イベントID (ULID)

type
required
string
Value: "lead.created"

イベント種別: lead.created(新規リード作成時)

sent_at
required
string <date-time>

送信日時

required
object (WebhookVendor)

ベンダー情報

required
object (WebhookVendorProgram)

ベンダープログラム情報

required
object (LeadCreatedData)

リード作成イベントのデータ

Responses

Request samples

Content type
application/json
{
  • "id": "01JCK1S3TSZ4KMW6TR84KF6EVT",
  • "type": "lead.created",
  • "sent_at": "2025-01-15T09:30:00Z",
  • "vendor": {
    },
  • "vendor_program": {
    },
  • "data": {
    }
}

リードステータス更新イベント

リードのステータスが更新された際に送信されるイベント。 type: "lead.status"

Request Body schema: application/json
required
id
required
string

イベントID (ULID)

type
required
string
Value: "lead.status"

イベント種別: lead.status(リードステータス更新時)

sent_at
required
string <date-time>

送信日時

required
object (WebhookVendor)

ベンダー情報

required
object (WebhookVendorProgram)

ベンダープログラム情報

required
object (LeadStatusData)

リードステータス更新イベントのデータ

Responses

Request samples

Content type
application/json
{
  • "id": "01JCK1S3TSZ4KMW6TR84KF6EVT",
  • "type": "lead.status",
  • "sent_at": "2025-01-15T09:30:00Z",
  • "vendor": {
    },
  • "vendor_program": {
    },
  • "data": {
    }
}

報酬作成イベント

新しい報酬レコードが作成された際に送信されるイベント。 type: "reward.created"

Request Body schema: application/json
required
id
required
string

イベントID (ULID)

type
required
string
Value: "reward.created"

イベント種別: reward.created(新規報酬作成時)

sent_at
required
string <date-time>

送信日時

required
object (WebhookVendor)

ベンダー情報

required
object (WebhookVendorProgram)

ベンダープログラム情報

required
object (RewardCreatedData)

報酬作成イベントのデータ

Responses

Request samples

Content type
application/json
{
  • "id": "01JCK1S3TSZ4KMW6TR84KF6EVT",
  • "type": "reward.created",
  • "sent_at": "2025-01-15T09:30:00Z",
  • "vendor": {
    },
  • "vendor_program": {
    },
  • "data": {
    }
}

報酬ステータス更新イベント

報酬のステータスが更新された際に送信されるイベント。 type: "reward.status"

Request Body schema: application/json
required
id
required
string

イベントID (ULID)

type
required
string
Value: "reward.status"

イベント種別: reward.status(報酬ステータス更新時)

sent_at
required
string <date-time>

送信日時

required
object (WebhookVendor)

ベンダー情報

required
object (WebhookVendorProgram)

ベンダープログラム情報

required
object (RewardStatusData)

報酬ステータス更新イベントのデータ

Responses

Request samples

Content type
application/json
{
  • "id": "01JCK1S3TSZ4KMW6TR84KF6EVT",
  • "type": "reward.status",
  • "sent_at": "2025-01-15T09:30:00Z",
  • "vendor": {
    },
  • "vendor_program": {
    },
  • "data": {
    }
}

パートナープログラム申請イベント

パートナーがベンダープログラムに申請した際に送信されるイベント。 type: "vendor_program.partner.created"

Request Body schema: application/json
required
id
required
string

イベントID (ULID)

type
required
string
Value: "vendor_program.partner.created"

イベント種別: vendor_program.partner.created(プログラムにパートナーが申請時)

sent_at
required
string <date-time>

送信日時

required
object (WebhookVendor)

ベンダー情報

required
object (WebhookVendorProgram)

ベンダープログラム情報

required
object (VendorProgramPartnerCreatedData)

パートナープログラム申請イベントのデータ

Responses

Request samples

Content type
application/json
{
  • "id": "01JCK1S3TSZ4KMW6TR84KF6EVT",
  • "type": "vendor_program.partner.created",
  • "sent_at": "2025-01-15T09:30:00Z",
  • "vendor": {
    },
  • "vendor_program": {
    },
  • "data": {
    }
}

パートナーステータス更新イベント

パートナーのプログラム参加ステータスが更新された際に送信されるイベント。 type: "vendor_program.partner.status"

Request Body schema: application/json
required
id
required
string

イベントID (ULID)

type
required
string
Value: "vendor_program.partner.status"

イベント種別: vendor_program.partner.status(プログラム参加中パートナーステータス更新時)

sent_at
required
string <date-time>

送信日時

required
object (WebhookVendor)

ベンダー情報

required
object (WebhookVendorProgram)

ベンダープログラム情報

required
object (VendorProgramPartnerStatusData)

パートナーステータス更新イベントのデータ

Responses

Request samples

Content type
application/json
{
  • "id": "01JCK1S3TSZ4KMW6TR84KF6EVT",
  • "type": "vendor_program.partner.status",
  • "sent_at": "2025-01-15T09:30:00Z",
  • "vendor": {
    },
  • "vendor_program": {
    },
  • "data": {
    }
}

活動ログ作成イベント

新しい活動ログが作成された際に送信されるイベント。 type: "activity_log.created"

Request Body schema: application/json
required
id
required
string

イベントID (ULID)

type
required
string
Value: "activity_log.created"

イベント種別: activity_log.created(新規活動ログ作成時)

sent_at
required
string <date-time>

送信日時

required
object (WebhookVendor)

ベンダー情報

required
object (WebhookVendorProgram)

ベンダープログラム情報

required
object (ActivityLogCreatedData)

活動ログ作成イベントのデータ

Responses

Request samples

Content type
application/json
{
  • "id": "01JCK1S3TSZ4KMW6TR84KF6EVT",
  • "type": "activity_log.created",
  • "sent_at": "2025-01-15T09:30:00Z",
  • "vendor": {
    },
  • "vendor_program": {
    },
  • "data": {
    }
}