KAkarte
ContactData

Upsert contact data

問い合わせデータを作成・更新します。 既に同一IDの問い合わせデータが存在する場合は、既存のデータを上書きします。 visitorId・userIdはオプショナルのフィールドですが、どちらも未指定の場合、問い合わせデータとWeb行動の紐付けができず、分析ができません。 そのため、どちらかはなるべく指定してください。 また、個人情報が入りうるフィールド(text, additionalNote)が存在する場合、visitorId・userIdのいずれも未指定だとAPIリクエストを受け付けません。(個人情報保護の観点で、ユーザーを指定した問い合わせデータの消去を後からできるようにするためです)

Required Scope

APIの実行に必要なScopeです。

beta.rightsupport.contactData.upsert

Required Role

管理画面でScopeを追加する際に必要な権限です。

RightSupport > RightSupportの編集
post/v2beta/rightsupport/contactData/upsert

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/rightsupport/contactData/upsert
  • Auth
    HTTP bearer

Headers

x-karte-apistring

今後利用する可能性のある予約語です。現在は設定不要です。

authorizationstring

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

content-typestring

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Request body

idstring required

問い合わせデータのID。(お客様のシステム側で採番されたもの)

contactedAtstring required

問い合わせ発生時刻。ISO8601フォーマットで指定してください。例1(UTCでの指定): 2022-09-29T05:39:56Z / 例2(JSTでの指定): 2022-09-29T05:39:56+09:00

channel'call' | 'chat' | 'form' | 'other' required

問い合わせチャネル。call, chat, form, otherのいずれかを指定してください。

contactPointIdstring required

問い合わせ窓口のID。(お客様のシステム側で採番されたもの)

userIdstring

ユーザーID。(KARTEのidentifyイベントで飛ばしているユーザーIDと同一のものが送信できる場合に指定してください)

visitorIdstring

KARTEのビジターID。なお、先頭にvis-はつけないでください。

reasonIdstring

問い合わせのカテゴリを表すID。(お客様のシステム側で採番されたもの)

urlToContactDetailstring

お客様の問い合わせ管理システム(CRMなど)で、問い合わせの詳細が閲覧できるページのURL。

textstring

問い合わせ内容本文。

additionalNotestring

問い合わせに関する追加メモ。

Example request

{
  "id": "c-id",
  "contactedAt": "2022-09-29T05:39:56Z",
  "channel": "call",
  "contactPointId": "cp-id",
  "userId": "u-id",
  "visitorId": "AaBbCcD1",
  "reasonId": "r-id",
  "urlToContactDetail": "https://example.com/c-id",
  "text": "問い合わせ内容本文です。",
  "additionalNote": "追加メモの文章です。"
}

Response

A successful response.

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.