Mazrica Sales Open API (v2)

Download OpenAPI specification:

Overview

Mazrica Sales のデータを操作するための公開 API (v2) です。本ドキュメントをご確認のうえご利用ください。API は随時拡張していきます。

Introduction

オンラインマニュアル: MazricaAPIを利用する – Mazrica

Endpoints

API のエンドポイントのベース URL は以下です。バージョンの v2 を含めてリクエストしてください。

https://api.mazrica.com/v2/{PATH_TO_REQUEST}

Authentication

認証は PAT(Personal Access Token, mzp_ プレフィックス)または TAT(Team Access Token, mzt_ プレフィックス)による Bearer 認証です。すべてのリクエストの Authorization ヘッダーに Bearer トークンを指定してください。

Authorization: Bearer mzp_xxxxxxxxxxxxxxxx
Content-Type: application/json

curl の例:

curl -X GET 'https://api.mazrica.com/v2/deals' \
  -H 'Authorization: Bearer mzp_xxxxxxxxxxxxxxxx' \
  -H 'Content-Type: application/json'

トークン種別と権限

  • PAT(mzp_): 権限設定 を利用しているドメインでは、トークンを発行したユーザーの権限が適用されます。閲覧・操作できる範囲はそのユーザーのロールに従い、権限外のデータは取得・操作できません。一覧・検索では権限のあるデータのみがヒットし、権限不足でも 403 ではなくスコープ内の結果(該当なしの場合は空)を返します。権限設定 を利用していないドメインでは制限はありません。
  • TAT(mzt_): ユーザー権限による絞り込みはなく、ドメイン内のデータを制限なく操作できます。

Requests Limit

レート制限を超えた場合は 429 Too Many Requests を返します。日次の上限は UTC 0 時境界でリセットされます。

トークン種別 集計単位 秒間上限 日次上限
PAT (mzp_) ユーザー単位(同一ユーザーの複数 PAT と、MCP 連携経由の利用を合算) 5 req/sec 50,000
TAT (mzt_) ドメイン単位(同一ドメインの複数 TAT を合算) 5 req/sec 200,000

Sort

一覧取得(GET)

一覧を返す API は sort クエリパラメータで並び順を指定できます。キーの前に - を付けると降順になります。指定できるキーと既定の並び順はエンドポイントごとに異なるため、各エンドポイントの sort パラメータの説明を参照してください。

  • 例: GET /v2/customers?sort=createdAt(作成日時の昇順)、GET /v2/customers?sort=-updatedAt(更新日時の降順)

ユーザー(Users)

実行ユーザー情報の取得

  • アクセストークンで実行しているユーザー自身の情報を取得します
  • permissions には、そのユーザーが持つ権限の識別子が入ります
  • 実行ユーザーを特定できない認証(チームアクセストークン等)では 403 になります
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "email": "string",
  • "domainId": 0,
  • "profile": {
    },
  • "permissions": [
    ]
}

ユーザー情報リスト取得

  • ユーザー情報のリスト取得
  • 一度に取得できる件数は100件
  • page を指定することで続きを取得(v1同様のページ方式)
Authorizations:
bearer_auth
query Parameters
page
integer >= 1
Default: 1

ページ番号(1始まり)。未指定時は1ページ目

deleted
integer
Default: 0
Enum: 0 1
  • 0 削除ユーザーは取得されません
  • 1 削除ユーザーも含めて取得します
email
string

指定したEメールアドレスのユーザーのみ取得します

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "totalCount": 0,
  • "page": 0
}

ユーザーグループ(UserGroups)

ユーザーグループ情報リスト取得

ユーザーグループ一覧をv1同様のページ方式で取得します。

  • レスポンスは v1同様の userGroups キー ({ userGroups, totalCount, page })
  • userId を指定すると、そのユーザーが所属するグループのみ返す
Authorizations:
bearer_auth
query Parameters
page
integer >= 1
Default: 1

ページ番号(1始まり)。未指定時は1ページ目

userId
integer

ユーザーID

Responses

Response samples

Content type
application/json
{
  • "userGroups": [
    ],
  • "totalCount": 0,
  • "page": 0
}

ユーザーグループ情報更新

ユーザーグループの属性を更新します。

  • 指定したフィールドのみ更新します(部分更新)
  • グループ名は必須で、255文字以内かつ同一組織内で重複しない値を指定してください
Authorizations:
bearer_auth
path Parameters
id
required
integer

ユーザーグループID

Request Body schema: application/json
name
string <= 255 characters

ユーザーグループ名

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "orderNum": 0
}

ユーザーグループメンバー追加

ユーザーグループにメンバー(ユーザー)を1人追加します。

  • 認証: PAT (mzp_xxx) または TAT (mzt_xxx) の Bearer トークン
  • PAT の場合、トークン所有ユーザーにプロファイル権限の「メンバー設定」が必要です
  • 既存メンバーは維持し、指定ユーザーを追加します(追加であり置換ではありません)
  • 既にメンバーの場合も冪等に成功します
  • userId を省略した場合はメンバーを追加せず 200 を返します
  • 対象ユーザーが既に別のグループに所属している場合は 400 を返します
Authorizations:
bearer_auth
path Parameters
userGroupId
required
integer

ユーザーグループID

Request Body schema: application/json
required
userId
integer

指定したユーザーグループに追加するユーザーのID

userId を指定しない場合はメンバーを追加せず、200 を返します

Responses

Request samples

Content type
application/json
{
  • "userId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "orderNum": 0,
  • "users": [
    ]
}

ユーザーグループメンバー除外

ユーザーグループから指定メンバー(ユーザー)を除外します。

  • 認証: PAT (mzp_xxx) または TAT (mzt_xxx) の Bearer トークン
  • PAT の場合、トークン所有ユーザーにプロファイル権限の「メンバー設定」が必要です
  • パス末尾の {userId} は除外するユーザーのID
  • ユーザーグループまたは対象ユーザーが存在しない(別ドメイン含む)場合は 404 を返します
  • この操作でユーザー自体が削除されることはありません
Authorizations:
bearer_auth
path Parameters
userGroupId
required
integer

ユーザーグループID

userId
required
integer

ユーザーID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

ユーザーグループメンバー一括更新

ユーザーグループのメンバーを userIds で完全置換します(追加ではありません)。

  • 認証: PAT (mzp_xxx) または TAT (mzt_xxx) の Bearer トークン
  • PAT の場合、トークン所有ユーザーにプロファイル権限の「メンバー設定」が必要です
  • userIds に含まれない既存メンバーは除外されます。空配列 [] を指定すると全メンバーを除外します
  • userIds を省略した場合はメンバーを変更せず 200 を返します
Authorizations:
bearer_auth
path Parameters
userGroupId
required
integer

ユーザーグループID

Request Body schema: application/json
required
userIds
Array of integers or null

ユーザーID(複数指定)

  • userIds を指定しない場合、ユーザーグループのメンバーは更新されません
  • userIds: [] を指定した場合、グループの所属ユーザーをすべて除外します

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "orderNum": 0,
  • "users": [
    ]
}

ロール(Roles)

ロール情報リスト取得

  • ロール情報のリスト取得
  • 一度に取得できる件数は100件
  • page を指定することで続きを取得(v1同様のページ方式)
Authorizations:
bearer_auth
query Parameters
page
integer >= 1
Default: 1

ページ番号(1始まり)。未指定時は1ページ目

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ],
  • "totalCount": 0,
  • "page": 0
}

取引先設定(CustomerSetting)

取引先設定

取引先詳細項目の定義の一覧と、取引先一覧の期間別カラーラベルを取得します。

  • ページングはありません。ドメイン内の全ての取引先詳細項目を並び順(orderNum)の昇順で返します
  • 選択肢(customItemOptions)は itemType が single_select / multi_select の項目のみ値が設定されます
  • カラーラベル(customerSearchActionRanges)は並び順(orderNum)の昇順で返します。画面ではカラーラベルは3件で、追加・削除できません。色は画面で変更できません
  • カラーラベルを一度も保存していない場合は、画面と同じ初期値の3件を返します。このとき id は null になります
  • 結果を編集して、取引先設定更新(PATCH /v2/customer_setting)に送れます
  • 取引先詳細項目(customerCustomItems)は v1 と同じ形の簡易な一覧で、取引先詳細項目グループ・画面上の並び・表示形式(uiMode)を含みません。それらが要る時は取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)を使います
  • 取引先詳細項目設定情報との違いは次のとおりです
    • このAPIは、ドメインの設定で利用していない項目タイプ(ユーザー)の項目も返します。取引先詳細項目設定情報は返しません
    • このAPIは、表示形式がラベルの項目も itemType を multi_select で返します。取引先詳細項目設定情報は label で返します
  • 返り値の例は、カラーラベルを一度も保存していないドメインのものです。保存済みのドメインでは、カラーラベルの id に値が入ります
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "customerCustomItems": [
    ],
  • "customerSearchActionRanges": [
    ]
}

取引先設定更新

取引先一覧で、直近のアクション完了日からの経過日数に応じて付く色ラベル(カラーラベル)の、名前と経過日数の上限を更新します。

  • 取引先設定(GET /v2/customer_setting)の結果を編集して送れます。そのまま送ると何も変わりません。ただし、カラーラベルを一度も保存していない場合は、同じ値のまま保存されて id が付きます
  • リクエストに記載の無いキー(customerCustomItems、カラーラベルの id・minDays など)は無視されます
  • 省略した設定・キーは変わりません。カラーラベル(customerSearchActionRanges)の省略・空配列は変更なしです。null は指定できません
  • カラーラベルを変更するときは、取得結果と同じ件数(通常は3件)を同じ並びでまとめて送ります。配列の位置で、更新するカラーラベルが決まります。変えないカラーラベルは空のオブジェクト({})で送ります。件数を変えると400になります
  • 変更できるのはラベル名(name)と経過日数の上限(maxDays)だけです。色(colorCode)と並び順(orderNum)は変更できず、現在と違う値を送ると400になります。カラーラベルは追加・削除できません
  • ラベル名は1〜10文字です。空文字・null は指定できません(空白だけの名前は受けます)。文字数は、変えたラベル名だけを確かめます
  • 経過日数の下限(minDays)は自動で決まります。前のカラーラベルの上限(maxDays)を変えると、次のカラーラベルの下限は、変えた上限+1になります
  • 後ろのカラーラベルの上限(maxDays)は自動では変わりません。1件でも変えた時は、全件について「下限(minDays)<上限(maxDays)≦999」を確かめ、満たさない行があれば400になります。後ろの行も合わせて変える時は、全件の maxDays をまとめて送ります
  • カラーラベルを一度も保存していない場合は、画面と同じ初期値に送った値を重ねて保存します
  • 取引先詳細項目は更新されません
  • 同じ内容を再送しても結果は同じです
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: customerSearchActionRanges[1].maxDays)を文頭に付けて最初の1件を返します
  • レスポンスは取引先設定と同じ形です
Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

取引先一覧の期間別カラーラベル一覧。省略・空配列の場合は変更なし。null は指定不可。取得結果と同じ件数・同じ並びで送り、配列の位置で更新するカラーラベルが決まる。変えないカラーラベルは空のオブジェクト({})で送る。追加・削除はできない

Responses

Request samples

Content type
application/json
{
  • "customerSearchActionRanges": [
    ]
}

Response samples

Content type
application/json
{
  • "customerCustomItems": [ ],
  • "customerSearchActionRanges": [
    ]
}

取引先詳細項目一括登録・更新・削除

取引先詳細項目の定義を一括で登録・更新・削除します(同期実行)。

  • リクエストボディは取引先詳細項目の配列です。要素ごとに、id を指定すると更新、省略すると登録、id と delete: true で削除します
  • 選択肢(customItemOptions)も同じく、id の有無と delete で登録・更新・削除を切り替えます
  • 操作ごとに送るキーは次のとおりです
操作 必ず送るキー 補足
取引先詳細項目の登録 itemType・name orderNum を省略すると0になります。表示形式(uiMode)と取引先詳細項目グループは指定できません
取引先詳細項目の更新 id 送ったキーだけ変わります。itemType は変更できません(有効な名前を送っても無視します。不正な名前は400になります)。customItemOptions に入れなかった選択肢は変わりません
取引先詳細項目の削除 id・delete: true 他のキーは保存に使いません
選択肢の登録 label value を省略すると、その取引先詳細項目の選択肢の value の最大値+1になります
選択肢の更新 id・value・label value を省略すると、新規登録として扱います
選択肢の削除 id・delete: true 削除した選択肢を選んでいた取引先の値は消えます
  • 送った選択肢の並び順は、customItemOptions の配列の順(削除を含めた位置)になります。送らなかった選択肢の並び順は変わらないため、並べ替える時は全選択肢を送ります
  • 成功時は操作後のドメイン内の全ての取引先詳細項目(customerCustomItems)と、リクエストの要素ごとの処理結果(results)を返します。登録した取引先詳細項目の id は自動で採番され、results で返ります
  • 400は、原因によって次の3つの形で返します
    • Error400(error・messages): itemType が不正な名前の時など、リクエストの形が誤っている時。1件も保存しません
    • CustomerSettingBulkErrors(errors): 保存前の事前チェック(項目数・選択肢数の上限超過、ドメインに無い取引先詳細項目ID・選択肢ID、その取引先詳細項目に属さない選択肢ID、Webフォームで使われている取引先詳細項目・選択肢の削除)に引っかかった時。1件も保存しません。選択肢数の上限は、itemType に single_select・multi_select を指定した要素の、送った選択肢の数で確かめます。項目数・選択肢数の上限が設定されていないドメインでは、上限の検査をしません
    • ErrorValidationFailed(error・errors・messages): 保存時の検証(項目名が空、取引先詳細項目で扱えない項目タイプなど)に引っかかった時。保存は配列の要素ごとに行うため、それより前の要素の保存結果は残ります
  • 項目キー(itemKey)・選択肢の値(value)の重複は事前チェックしません。保存の途中で見つかった時は、それより前の要素を保存したうえで、事前チェックと同じ errors の形で400を返します
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • このAPIを使って登録した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)
Authorizations:
bearer_auth
Request Body schema: application/json
required
Array
id
integer or null

取引先詳細項目ID。既存アイテムの更新時に指定します。省略した場合は新規登録として扱われます。

itemKey
string or null

API項目キー

itemType
required
string

取引先詳細項目タイプ。text, date, number, decimal_number, url, single_select, multi_select, user のいずれかになります。既に登録されている項目のタイプは変更できません(指定しても無視されます)。

name
required
string

取引先詳細項目名

orderNum
integer

並び順

delete
boolean or null

trueを指定すると該当項目を削除します。idと併せて指定してください。

Array of objects or null (CustomerSettingBulkRequestItemOption)

取引先詳細選択項目リスト。itemType が single_select または multi_select の場合に指定します。並び順は配列の順序になります。

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "customerCustomItems": [
    ],
  • "results": [
    ]
}

取引先詳細項目設定情報

ドメインに設定された取引先詳細項目と取引先詳細項目グループを、設定画面と同じ並びで取得します。

  • レスポンスは { "layout": [...] } の形で、全件を1回で返します(ページングはありません)
  • 取引先設定(GET /v2/customer_setting)の取引先詳細項目(customerCustomItems)は簡易な一覧です。取引先詳細項目グループ・並び順・表示形式はこのAPIで取得してください
  • layout は画面の並び順に並び、グループに入っていない取引先詳細項目(customerCustomItem)と取引先詳細項目グループ(customerCustomItemGroup)が混在します。グループ内の取引先詳細項目は、グループの customerCustomItems にグループ内の並び順で並びます
  • 選択肢(customItemOptions)は itemType が single_select・multi_select・label の項目のみ値が設定されます
  • 表示形式(uiMode)は、single_select が 1(プルダウン)か 2(ラジオボタン)、multi_select が 1(プルダウン)か 3(チェックボックス)、itemType が label の項目が 4(ラベル)です。それ以外の itemType の項目と、表示形式が設定されていない選択型の項目(一括登録(POST /v2/customer_setting/bulk)で作った項目など)は null です
  • ユーザー型(itemType が user)の選択肢は返しません。ユーザーはユーザー情報リスト取得(GET /v2/users)で取得してください
  • ドメインの設定で利用していない項目タイプ(ユーザー)の取引先詳細項目は返しません。取引先設定(GET /v2/customer_setting)の取引先詳細項目は、利用していない項目タイプの項目も返します
  • PAT の場合、権限設定を利用しているドメインでは取引先の編集権限が無いと 403 になります
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "layout": [
    ]
}

取引先詳細項目設定情報登録

ドメインに取引先詳細項目を1件、選択肢と合わせて登録します。

  • 取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)で取得した取引先詳細項目1件を、そのまま送れます。リクエストに記載の無いキー(各要素の id など)は無視されます
  • 並び位置(before)を指定するとその要素の前に入り、後ろの要素は順にずれます。省略するとグループ内・グループ外の末尾に入ります
  • 並び位置(before)の省略・null の意味は、取引先詳細項目・取引先詳細項目グループの登録・更新で次のように違います
before 取引先詳細項目の登録 取引先詳細項目の更新 取引先詳細項目グループの登録 取引先詳細項目グループの更新
省略 入れる先(グループ内・グループ外)の末尾 位置を変えない(所属を変えた時は移動先の末尾) 先頭 位置を変えない
null 入れる先の末尾 移動先の末尾 指定できない(400) 末尾
{ "customerCustomItemId": n } n の前 n の前 n の前(グループに入っていない取引先詳細項目のみ) 同左
{ "customerCustomItemGroupId": n } n の前(グループ外に入れる時のみ) 同左 n の前 n の前(自分以外)
  • single_select・multi_select は選択肢(customItemOptions)を1件以上送ります。選択肢の値(value)を省略すると自動で採番されます。移行・複製では複製元の値をそのまま送ります
  • 表示形式(uiMode)を省略すると、画面で作成した時と同じ表示形式(single_select はラジオボタン、multi_select はチェックボックス)になります
  • 表示形式がラベルの取引先詳細項目(itemType が label)と、ドメインの設定で利用していない取引先詳細項目タイプ(ユーザー)の取引先詳細項目は登録できません
  • 取引先詳細項目数・選択肢数がドメインの上限を超える時は400になり、messages に上限数が入ります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も登録されません。入力エラーの messages は、誤りのある場所(例: customItemOptions[1].label)を文頭に付けて最初の1件を返します
  • API項目キー(itemKey)の無い内容を再送すると、同じ取引先詳細項目がもう1件作られます。itemKey を指定した再送は、同じAPI項目キーの取引先詳細項目があるため400になります
  • レスポンスは取引先詳細項目設定情報の取引先詳細項目(customerCustomItem)と同じ形です

別の環境へ同じ並びで複製する手順は次のとおりです。複製先に取引先詳細項目・取引先詳細項目グループが無い場合に、複製元と同じ並びになります。

  1. 複製元で取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)を呼び、layout を得ます
  2. layout の要素を後ろから順に作ります。グループに入っていない取引先詳細項目は本APIで、取引先詳細項目グループは取引先詳細項目グループ設定情報登録(POST /v2/customer_setting/customer_custom_item_groups)で作ります。最初の1つは before をキーごと省きます(取引先詳細項目グループの登録は before に null を送ると400です)。2つ目以降は直前に作った要素を before に指定します({"customerCustomItemId": 作った取引先詳細項目の id} か {"customerCustomItemGroupId": 作ったグループの id})
  3. 取引先詳細項目グループの中の取引先詳細項目を、グループ内の前から順に本APIで作ります。customerCustomItemGroupId に手順2で作ったグループの id を指定し、before は省略します(グループ内の末尾に入ります)
  4. 選択肢の value は複製元の値をそのまま送ります。ID(customerCustomItemGroupId と before の中のID)は環境ごとに異なるため、必ず複製先で作った要素の id に置き換えます
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string

取引先詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存

itemType
required
string

取引先詳細項目タイプ。以下のいずれか

  • text: テキスト
  • url: URL
  • date: 日付
  • number: 数値
  • decimal_number: 数値(小数点あり)
  • single_select: 単一選択(表示形式は uiMode)
  • multi_select: 複数選択(表示形式は uiMode)
  • user: ユーザー
itemKey
string or null

API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。空文字・空白だけの時は null として保存

uiMode
integer or null

表示形式。itemType が single_select・multi_select の時のみ使用。省略・null の時は画面で作成した時と同じ値

  • single_select: 1(プルダウン)か 2(ラジオボタン)。省略時は 2
  • multi_select: 1(プルダウン)か 3(チェックボックス)。省略時は 3
  • 上記以外の itemType: 指定しても null
customerCustomItemGroupId
integer or null

所属する取引先詳細項目グループID。省略・null の時はグループに入れない

object or null

並び位置。省略・null の時は入れる先(グループ内・グループ外)の末尾

Array of objects or null (CustomerCustomItemCreateOption)

取引先詳細選択項目リスト。itemType が single_select・multi_select の時は1件以上必須で、配列の順が並び順。それ以外の itemType では空か省略

Responses

Request samples

Content type
application/json
Example
{
  • "name": "社内メモ",
  • "itemType": "text",
  • "itemKey": "memo"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemKey": "string",
  • "name": "string",
  • "itemType": "string",
  • "uiMode": 0,
  • "customerCustomItemGroupId": 0,
  • "customItemOptions": [
    ]
}

取引先詳細項目設定情報更新

取引先詳細項目1件を、送った項目だけ変更します。省略した項目は変更されません。

  • 取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)で取得した取引先詳細項目1件を、そのまま送れます。そのまま送った時は何も変わりません。リクエストに記載の無いキーは無視されます
  • 取引先詳細項目タイプ(itemType)と既存の選択肢の値(value)は変更できません。現在と違う値を送ると400になります。型を変える時は、新しい取引先詳細項目を登録してから元の取引先詳細項目を削除します
  • 選択肢(customItemOptions)は差分で指定します。id のある選択肢は更新、id の無い選択肢は追加、id と deleted: true を指定した選択肢は削除されます。送らなかった選択肢は変わりません
  • 送った選択肢(削除を除く)は配列の順に並び、送らなかった選択肢は位置を保ちます。全体を並べ替える時は全選択肢を新しい順で送ります
  • 選択肢を削除すると、その選択肢を選んでいた取引先の値は消え、元に戻せません。コンタクト検索・案件一覧・レポート・BI・自動化などで、その取引先詳細項目を条件や表示に使っている場合も影響します
  • 最後の1件の選択肢は削除できません。削除されていない Webフォーム(非公開を含む)で使われている取引先詳細項目は、選択肢を削除できません
  • 表示形式がラベル(uiMode が 4。itemType が label の取引先詳細項目を含む)の取引先詳細項目は、表示形式と選択肢を変更できません。取得したままの選択肢のみ送れます
  • 並び位置(before)を指定するとその要素の前に移り、後ろの要素は順にずれます。before が null の時は移動先の末尾に移ります。省略した時は位置を変えません
  • 並び位置(before)の省略・null の意味は、取引先詳細項目・取引先詳細項目グループの登録・更新で次のように違います
before 取引先詳細項目の登録 取引先詳細項目の更新 取引先詳細項目グループの登録 取引先詳細項目グループの更新
省略 入れる先(グループ内・グループ外)の末尾 位置を変えない(所属を変えた時は移動先の末尾) 先頭 位置を変えない
null 入れる先の末尾 移動先の末尾 指定できない(400) 末尾
{ "customerCustomItemId": n } n の前 n の前 n の前(グループに入っていない取引先詳細項目のみ) 同左
{ "customerCustomItemGroupId": n } n の前(グループ外に入れる時のみ) 同左 n の前 n の前(自分以外)
  • グループへの出し入れは、所属する取引先詳細項目グループID(customerCustomItemGroupId)で行います。null の時はグループから出します。所属を変えて before を省略した時は、移動先の末尾に入ります
  • 取引先詳細項目・選択肢・取引先詳細項目グループのIDは環境ごとに異なります。別の環境の内容に合わせる時は、取引先詳細項目設定情報で移行先のIDを調べて置き換えます。移行先に無い選択肢は id を付けずに送ると追加されます
  • id の無い選択肢を含む内容を再送すると、そのたびに選択肢が追加されます。id のある変更だけの内容は、再送しても同じ結果になります
  • ドメインの設定で利用していない取引先詳細項目タイプ(ユーザー)の取引先詳細項目は、現在と違う値を送ると403になります
  • 選択肢数がドメインの上限を超える時は400になり、messages に上限数が入ります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も変更されません。入力エラーの messages は、誤りのある場所(例: customItemOptions[1].label)を文頭に付けて最初の1件を返します
  • レスポンスは取引先詳細項目設定情報の取引先詳細項目(customerCustomItem)と同じ形です
Authorizations:
bearer_auth
path Parameters
id
required
integer

取引先詳細項目ID

Request Body schema: application/json
required
name
string

取引先詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存

itemType
string

取引先詳細項目タイプ。変更不可(現在の値のみ指定可能)

itemKey
string or null

API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。null・空文字・空白だけの時は API項目キーを消す

uiMode
integer or null

表示形式。itemType が single_select・multi_select の時のみ変更可能。null には変更不可

  • single_select: 1(プルダウン)か 2(ラジオボタン)
  • multi_select: 1(プルダウン)か 3(チェックボックス)
  • 表示形式が 4(ラベル)の取引先詳細項目: 変更不可(4 のみ指定可能)
  • 上記以外の itemType: 指定しても変更しない
customerCustomItemGroupId
integer or null

所属する取引先詳細項目グループID。null の時はグループから出す。変更して before を省略した時は移動先の末尾に入る

object or null

並び位置。省略した時は位置を変えない。null の時は移動先(グループ内・グループ外)の末尾。この取引先詳細項目自身は指定不可

Array of objects or null (CustomerCustomItemUpdateOption)

取引先詳細選択項目リスト(差分)。itemType が single_select・multi_select の時のみ指定可能。送らなかった選択肢は変更しない。省略・null・空配列の時は変更しない。送った選択肢(削除を除く)は配列の順に並び、送らなかった選択肢は位置を保つ。表示形式が 4(ラベル)の時は取得したままの選択肢のみ指定可能(追加・変更・削除・並べ替え不可)

Responses

Request samples

Content type
application/json
Example
{
  • "customItemOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemKey": "string",
  • "name": "string",
  • "itemType": "string",
  • "uiMode": 0,
  • "customerCustomItemGroupId": 0,
  • "customItemOptions": [
    ]
}

取引先詳細項目設定情報削除

取引先詳細項目を1件削除します。削除は取り消せません。

  • 画面から削除した時と同じく、全取引先の入力済みの値と選択肢も削除され、元に戻せません
  • 取引先詳細項目は、コンタクト検索・案件一覧の並び替え・案件やコンタクトのレポート・BI・オートメーションからも参照されます。これらの参照は判定しないため、削除するとそれらの設定が動かなくなることがあります
  • Webフォーム(非公開を含み、削除したものを除く)で使われている取引先詳細項目は削除できず400になり、何も削除されません。messages に使用先のWebフォーム名が入ります。Webフォーム側で外してから削除します。Webフォームを利用していないドメインでは判定しません
  • Webフォームを利用していない間に削除すると、利用を再開した時にWebフォームに削除した取引先詳細項目が残ります
  • 残る取引先詳細項目・取引先詳細項目グループの並び順は変わりません
  • 選択肢の削除は取引先詳細項目設定情報更新(PATCH /v2/customer_setting/customer_custom_items/{id})で行います
  • 取引先詳細項目IDは取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)で調べます
  • ドメインの設定で利用していない取引先詳細項目タイプ(ユーザー)の取引先詳細項目は削除できず403になります
  • 削除済みの取引先詳細項目を指定すると404になります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
Authorizations:
bearer_auth
path Parameters
id
required
integer

取引先詳細項目ID

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "messages": [
    ]
}

取引先詳細項目グループ設定情報登録

ドメインに、取引先詳細項目の入っていない取引先詳細項目グループを1件登録します。

  • 取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)で取得した取引先詳細項目グループ(layout の customerCustomItemGroup)1件を、そのまま送れます。リクエストに記載の無いキー(id・customerCustomItems など)は無視されます
  • 登録できるのは名前と並び位置です。取引先詳細項目をグループに入れる時は、取引先詳細項目設定情報登録(POST /v2/customer_setting/customer_custom_items)・取引先詳細項目設定情報更新(PATCH /v2/customer_setting/customer_custom_items/{id})で所属する取引先詳細項目グループID(customerCustomItemGroupId)に、返された id を指定します
  • 並び位置(before)を指定するとその要素の前に入り、後ろの要素は順にずれます。指定できるのは、グループに入っていない取引先詳細項目と取引先詳細項目グループです。before に指定する ID は取引先詳細項目設定情報で取得します
  • 並び位置(before)を省略すると先頭に入り、他の要素は順を保って後ろにずれます。末尾を指定して登録することはできません。before に null は指定できません
  • 並び位置(before)の省略・null の意味は、取引先詳細項目・取引先詳細項目グループの登録・更新で次のように違います
before 取引先詳細項目の登録 取引先詳細項目の更新 取引先詳細項目グループの登録 取引先詳細項目グループの更新
省略 入れる先(グループ内・グループ外)の末尾 位置を変えない(所属を変えた時は移動先の末尾) 先頭 位置を変えない
null 入れる先の末尾 移動先の末尾 指定できない(400) 末尾
{ "customerCustomItemId": n } n の前 n の前 n の前(グループに入っていない取引先詳細項目のみ) 同左
{ "customerCustomItemGroupId": n } n の前(グループ外に入れる時のみ) 同左 n の前 n の前(自分以外)
  • 別の環境へ同じ並びで複製する手順は、取引先詳細項目設定情報登録(POST /v2/customer_setting/customer_custom_items)の説明を参照してください
  • ドメインの設定で利用していない取引先詳細項目タイプ(ユーザー)の取引先詳細項目は、before に指定できません
  • 取引先詳細項目数がドメインの上限を超えている時は400になり、messages に上限数が入ります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • エラーがあれば何も登録されません。入力エラーの messages は、誤りのある場所(例: before.customerCustomItemId)を文頭に付けて最初の1件を返します
  • 同じ内容を再送すると、同じ名前の取引先詳細項目グループがもう1件作られます
  • レスポンスは取引先詳細項目設定情報の取引先詳細項目グループ(customerCustomItemGroup)と同じ形です。登録直後の customerCustomItems は空です
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string

取引先詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。同じ名前のグループも登録可能

object

並び位置。グループに入っていない取引先詳細項目か取引先詳細項目グループの前に入り、後ろの要素は順にずれる。省略時は先頭。null は指定不可

Responses

Request samples

Content type
application/json
{
  • "name": "基本情報",
  • "before": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "customerCustomItems": [
    ]
}

取引先詳細項目グループ設定情報更新

取引先詳細項目グループ1件の名前と並び位置を更新します。

  • 指定した項目だけを更新し、省略した項目は変更しません
  • 取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)で取得した取引先詳細項目グループ(layout の customerCustomItemGroup)1件を、そのまま送れます。リクエストに記載の無いキー(id・customerCustomItems など)は無視されます
  • 更新できるのは名前と並び位置です。グループに入っている取引先詳細項目の出し入れは本APIでは行えません。取引先詳細項目設定情報更新(PATCH /v2/customer_setting/customer_custom_items/{id})で、所属する取引先詳細項目グループID(customerCustomItemGroupId)を変更します
  • 並び位置(before)を指定すると、グループは中の取引先詳細項目ごとその要素の前に移り、他の要素は順を保ってずれます。グループの中の取引先詳細項目の並びは変わりません。指定できるのは、グループに入っていない取引先詳細項目と、他の取引先詳細項目グループです。before に指定する ID は取引先詳細項目設定情報で取得します
  • before に null を指定すると末尾に移ります。登録したグループを末尾に置く時も、本APIで before に null を指定します。before を省略すると並び位置は変わりません
  • 並び位置(before)の省略・null の意味は、取引先詳細項目・取引先詳細項目グループの登録・更新で次のように違います
before 取引先詳細項目の登録 取引先詳細項目の更新 取引先詳細項目グループの登録 取引先詳細項目グループの更新
省略 入れる先(グループ内・グループ外)の末尾 位置を変えない(所属を変えた時は移動先の末尾) 先頭 位置を変えない
null 入れる先の末尾 移動先の末尾 指定できない(400) 末尾
{ "customerCustomItemId": n } n の前 n の前 n の前(グループに入っていない取引先詳細項目のみ) 同左
{ "customerCustomItemGroupId": n } n の前(グループ外に入れる時のみ) 同左 n の前 n の前(自分以外)
  • ドメインの設定で利用していない取引先詳細項目タイプ(ユーザー)の取引先詳細項目は、before に指定できません
  • 名前は変更する時だけ、前後の空白を除いて1〜100文字かを確認します。今と同じ名前はそのまま送れます
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • エラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: before.customerCustomItemId)を文頭に付けて最初の1件を返します
  • レスポンスは取引先詳細項目設定情報の取引先詳細項目グループ(customerCustomItemGroup)と同じ形です
Authorizations:
bearer_auth
path Parameters
id
required
integer

取引先詳細項目グループID

Request Body schema: application/json
required
name
string

取引先詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。null は指定不可

object or null

並び位置。グループに入っていない取引先詳細項目か他の取引先詳細項目グループの前に、中の取引先詳細項目ごと移り、他の要素は順にずれる。null は末尾。省略時は変更しない

Responses

Request samples

Content type
application/json
Example
{
  • "name": "与信情報(改)"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "customerCustomItems": [
    ]
}

取引先詳細項目グループ設定情報削除

取引先詳細項目グループ1件を削除します。

  • 削除したグループは元に戻せません
  • 中に取引先詳細項目が残っていても削除できます。中の取引先詳細項目は削除されず、グループに入っていない取引先詳細項目になり、入力済みの値も残ります
  • 中の取引先詳細項目は、削除したグループより後ろにあるグループに入っていない取引先詳細項目の最後の直後に、グループ内の並び順のまままとめて並びます。後ろにグループに入っていない取引先詳細項目が無ければ、削除したグループの位置に並びます
  • 他の取引先詳細項目と取引先詳細項目グループの並び順は変わりません
  • 別のグループへ移したい取引先詳細項目は、削除の前に取引先詳細項目設定情報更新(PATCH /v2/customer_setting/customer_custom_items/{id})で移します
  • ドメインの設定で利用していない取引先詳細項目タイプ(ユーザー)の取引先詳細項目は、グループに入っていない取引先詳細項目になるだけで、並び位置は変わりません
  • 取引先詳細項目グループIDと中の取引先詳細項目は、取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)で取得します
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
Authorizations:
bearer_auth
path Parameters
id
required
integer

取引先詳細項目グループID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

アクション設定(ActionSetting)

アクション設定

アクション詳細項目の定義と、アクション基本項目の説明を取得します。

  • レスポンスは data などで包まず、設定のオブジェクトをそのまま返します。全件を1回で返し、ページングはありません
  • アクション詳細項目(actionCustomItems)は、画面の並び順で返します
  • 基本項目設定(actionBasicFieldSettings)は、説明が未設定の項目も含め、全基本項目を定義順に返します
  • 結果は、基本項目の説明を編集してアクション設定情報更新(PATCH /v2/action_setting)に送れます
  • 選択肢(actionCustomItemOptions)を画面で作れるのは単一選択・複数選択タイプの項目のみです
  • ラベルタイプの項目のラベルは選択肢に含まれません。アクション詳細項目ラベルリスト(GET /v2/action_custom_items/{actionCustomItemKey}/labels)で取得します
  • 表示形式(uiMode)は単一選択・複数選択タイプの項目で使われます。未設定の項目は null になります
  • アクションの目的は案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})の actionsPurposes で取得できます
  • 取引先アクションのアクションテンプレートと紐付け先設定は、取引先アクション設定情報(GET /v2/action_setting/customer_action_setting)で取得できます
  • 案件アクションのアクションテンプレートと紐付け先設定は、案件タイプごとに案件アクション設定情報(GET /v2/action_setting/deal_action_settings/{deal_type_id})で取得できます
  • コンタクトアクションのアクションテンプレートと紐付け先設定は、コンタクトアクション設定情報(GET /v2/action_setting/contact_action_setting)で取得できます
  • ドメインでアクション詳細項目が利用可能になっていない場合は 403 になります
  • ドメインでラベルタイプが利用可能になっていない場合、ラベルタイプの項目は含まれません
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "actionCustomItems": [
    ],
  • "actionBasicFieldSettings": [
    ]
}

アクション設定情報更新

アクション基本項目の説明を更新します。

  • アクション設定(GET /v2/action_setting)の結果を編集して送れます。そのまま送ると何も変わりません
  • 基本項目設定(actionBasicFieldSettings)は、基本項目キー(field)で対象の項目を指定し、送った要素の説明だけが変わります。省略・空配列は変更なしです
  • 送らなかった基本項目と、説明(description)を省略した要素の説明は変わりません
  • 説明は null・空文字・空白だけを送ると消えます。前後の空白は除いて保存され、200文字以内で、途中に改行は使えません
  • 説明は、アクションの入力画面・詳細画面で、項目名の横に入力者向けに表示されます。変えた説明は全ユーザーの画面に反映されます
  • 基本項目の表示名は変更できません
  • アクション詳細項目は更新されません。詳細項目はアクション詳細項目設定情報登録(POST /v2/action_custom_items)・更新(PATCH /v2/action_custom_items/{item_key})で変更します
  • 紐付け先設定・アクションテンプレートは更新されません。取引先アクション設定情報更新(PATCH /v2/action_setting/customer_action_setting)・案件アクション設定情報更新(PATCH /v2/action_setting/deal_action_settings/{deal_type_id})・コンタクトアクション設定情報更新(PATCH /v2/action_setting/contact_action_setting)で変更します
  • アクションの目的は更新されません。案件タイプ設定情報更新(PATCH /v2/deal_setting/deal_types/{id})の actionsPurposes で変更します
  • ドメインでアクション詳細項目が利用可能になっていない場合も更新できます。このときレスポンスにアクション詳細項目(actionCustomItems)は含まれず、アクション設定の取得は 403 になるため、今の説明はこの更新のレスポンスで確認します
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • リクエストに記載の無いキーは無視されます
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: actionBasicFieldSettings[1].description)を文頭に付けて最初の1件を返します
  • レスポンスはアクション設定と同じ形です
Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

基本項目設定。省略・空配列の場合は変更なし。送った要素の説明だけが変わります

Responses

Request samples

Content type
application/json
{
  • "actionBasicFieldSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "actionCustomItems": [
    ],
  • "actionBasicFieldSettings": [
    ]
}

取引先アクション設定情報

取引先アクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を取得します。

  • レスポンスは data などで包まず、設定のオブジェクトをそのまま返します。全件を1回で返し、ページングはありません
  • 結果は、編集して取引先アクション設定情報更新(PATCH /v2/action_setting/customer_action_setting)に送れます
  • アクションテンプレート(customerActionTemplates)は、アクションの入力画面でテンプレートを選ぶと事前メモ(preNote)・実施結果(result)に差し込まれる文章です。紐付くアクション種別(patterns)のアクションで選べます
  • 紐付け先設定(actionCustomItemScopeSettings)は、取引先アクションの入力画面でのアクション詳細項目の表示・必須です。アクションの登録・更新 API では検査されません
  • 紐付け先設定は、アクション詳細項目ごとにアクション種別1〜5の5件を返します。並びはアクション設定(GET /v2/action_setting)のアクション詳細項目と同じで、項目ごとにアクション種別の昇順です。一度も設定していない組み合わせは、表示・必須とも false になります
  • アクション詳細項目は項目キー(itemKey)で指します。項目名・項目タイプ・選択肢はアクション設定(GET /v2/action_setting)で取得できます
  • ドメインでアクション詳細項目が利用可能になっていない場合、紐付け先設定は含まれません。アクションテンプレートは返します
  • ドメインでラベルタイプが利用可能になっていない場合、ラベルタイプの項目の紐付け先設定は含まれません
  • PAT の場合、権限設定を利用しているドメインでは取引先アクションの保存権限が無いと 403 になります
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "customerActionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

取引先アクション設定情報更新

取引先アクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を更新します。

1回のリクエストで、テンプレートの追加・変更・削除と、紐付け先設定の変更をまとめて送れます。送った要素だけが変わります。

したいこと 要素の書き方
テンプレートを追加 customerActionTemplates に、id を付けずに name と patterns を送る
テンプレートを変更 customerActionTemplates に、id と変えるキーだけを送る(省いたキーは変わらない)
テンプレートを削除 customerActionTemplates に、id と deleted: true を送る
表示・必須を変える actionCustomItemScopeSettings に、itemKey・pattern・visible・required の4つを送る(4つとも必須)

リクエストの例は、ID 12 のテンプレートの名前を変え、ID 13 のテンプレートの種別を面談・電話にし、ID 14 のテンプレートを削除し、電話のテンプレートを1件追加します。あわせて、項目 visit_purpose を面談で必須にし、メールでは表示しないようにします。

  • 取引先アクション設定情報(GET /v2/action_setting/customer_action_setting)の結果を編集して送れます。そのまま送ると何も変わりません
  • アクションテンプレート(customerActionTemplates)・紐付け先設定(actionCustomItemScopeSettings)とも、省略・空配列は変更なしです。テンプレートを全件削除するときは、各要素に削除の指定(deleted: true)を付けます
  • テンプレートの削除は元に戻せません。削除しても、既存のアクションに差し込まれた事前メモ・実施結果は変わりません
  • 種別(patterns)は送った一覧で置き換えます。同じ値は1つにまとめます。空の配列は送れません(今の種別が無いテンプレートに空の配列を送ったときだけは、変更なしとして受けます)
  • 事前メモテンプレート(actionData)・実施結果テンプレート(actionPoint)の空文字は null で保存されます
  • アクションテンプレートは300件まで登録できます。超える追加は400になります。同じリクエストで削除した分は追加できます
  • 紐付け先設定は、項目キー(itemKey)とアクション種別(pattern)の組み合わせで指定し、送った組み合わせだけが変わります。項目キーはアクション設定(GET /v2/action_setting)で取得できます
  • 表示しない(visible: false)組み合わせは必須(required: true)にできません
  • 表示しない組み合わせのアクション詳細項目は、取引先アクションの入力画面と詳細画面に出なくなります。保存済みの値は消えず、一覧・CSV・取得 API では見えます。表示に戻すと元どおりに出ます
  • 必須は画面の入力時に効きます。アクションの登録・更新 API では、表示・必須は検査されません
  • ドメインでアクション詳細項目が利用可能になっていない場合、紐付け先設定は変更できず、値を変える組み合わせを送ると 403 になります。アクションテンプレートは更新できます
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • リクエストに記載の無いキーは無視されます
  • アクション詳細項目そのもの、案件アクション・コンタクトアクションの設定は更新されません
  • id の無い要素(追加)を含むリクエストを送り直すと、同じテンプレートがもう1件追加されます。通信の失敗などで送り直すときは、先に取得して追加済みかを確かめてください
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: customerActionTemplates[1].patterns)を文頭に付けて最初の1件を返します。アクションテンプレート、紐付け先設定の順に検査します
  • レスポンスは取引先アクション設定情報と同じ形です
Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects (CustomerActionTemplateUpdateParam)

取引先アクションテンプレート一覧。省略・空配列の場合は変更なし。送った要素だけが変わります

Array of objects

アクション詳細項目紐付け先設定一覧。省略・空配列の場合は変更なし。送った項目キー(itemKey)とアクション種別(pattern)の組み合わせだけが変わります

Responses

Request samples

Content type
application/json
{
  • "customerActionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "customerActionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

案件アクション設定情報

案件タイプ1つの案件アクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を取得します。

  • レスポンスは data などで包まず、設定のオブジェクトをそのまま返します。全件を1回で返し、ページングはありません
  • アクションテンプレート(actionTemplates)は、アクションの入力画面でテンプレートを選ぶと事前メモ(preNote)・実施結果(result)に差し込まれる文章です。紐付くアクションの目的(purposeIds)のアクションで選べます
  • アクションの目的の名前・種別は案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})の actionsPurposes で取得できます
  • 紐付け先設定(actionCustomItemScopeSettings)は、指定した案件タイプの案件アクションの入力画面でのアクション詳細項目の表示・必須です。アクションの登録・更新 API では検査されません
  • 紐付け先設定は、アクション詳細項目ごとにアクション種別1〜5の5件を返します。並びはアクション設定(GET /v2/action_setting)のアクション詳細項目と同じで、項目ごとにアクション種別の昇順です。一度も設定していない組み合わせは、表示・必須とも false になります。後から追加した案件タイプでは、既存のアクション詳細項目は表示・必須とも false です
  • アクション詳細項目は項目キー(itemKey)で指します。項目名・項目タイプ・選択肢はアクション設定(GET /v2/action_setting)で取得できます
  • ドメインでアクション詳細項目が利用可能になっていない場合、紐付け先設定は含まれません。アクションテンプレートは返します
  • ドメインでラベルタイプが利用可能になっていない場合、ラベルタイプの項目の紐付け先設定は含まれません
  • PAT の場合、権限設定を利用しているドメインでは、指定した案件タイプのアクションの保存権限が無いと 403 になります
  • 結果は編集して案件アクション設定情報更新(PATCH /v2/action_setting/deal_action_settings/{deal_type_id})に送れます。別の案件タイプへ送るときは、アクションテンプレートの id を外し、目的の ID を種別と名前が同じ送り先の案件タイプの目的の ID に置き換えます
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

Responses

Response samples

Content type
application/json
{
  • "actionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

案件アクション設定情報更新

案件タイプ1つの案件アクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を更新します。

1回のリクエストで、テンプレートの追加・変更・削除と、紐付け先設定の変更をまとめて送れます。送った要素だけが変わります。

したいこと 要素の書き方
テンプレートを追加 actionTemplates に、id を付けずに name と purposeIds を送る
テンプレートを変更 actionTemplates に、id と変えるキーだけを送る(省いたキーは変わらない)
テンプレートを削除 actionTemplates に、id と deleted: true を送る
表示・必須を変える actionCustomItemScopeSettings に、itemKey・pattern・visible・required の4つを送る(4つとも必須)

テンプレートは、取引先・コンタクトと違い、アクション種別ではなくアクションの目的(purposeIds)に紐付けます。目的の ID は、案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})の actionsPurposes[].id で取得できます。

リクエストの例は、ID 31 のテンプレートを目的 101・103 で選べるようにし、目的 103 のテンプレートを1件追加します。あわせて、項目 visit_purpose を面談で表示します。

  • 案件アクション設定情報(GET /v2/action_setting/deal_action_settings/{deal_type_id})の結果を編集して送れます。そのまま送ると何も変わりません
  • アクションテンプレート(actionTemplates)・紐付け先設定(actionCustomItemScopeSettings)とも、省略・空配列は変更なしです。テンプレートを全件削除するときは、各要素に削除の指定(deleted: true)を付けます
  • 指定した案件タイプのテンプレートだけを id で指定できます
  • テンプレートの削除は元に戻せません。削除しても、既存のアクションに差し込まれた事前メモ・実施結果は変わりません
  • 目的(purposeIds)は送った一覧で置き換えます。同じ値は1つにまとめます。空の配列は送れません(今の目的が無いテンプレートに空の配列を送ったときだけは、変更なしとして受けます)。指定した案件タイプの目的だけを指定できます
  • 新しい目的は、先に案件タイプ更新(PATCH /v2/deal_setting/deal_types/{id})で作ります。目的を削除すると、テンプレートとの紐付けも外れます
  • 事前メモテンプレート(actionData)・実施結果テンプレート(actionPoint)の空文字は空文字のまま保存されます
  • アクションテンプレートはドメイン全体(全案件タイプの合計)で300件まで登録できます。超える追加は400になります。同じリクエストで削除した分は追加できます
  • 紐付け先設定は、項目キー(itemKey)とアクション種別(pattern)の組み合わせで指定し、送った組み合わせだけが変わります。項目キーはアクション設定(GET /v2/action_setting)で取得できます
  • 表示しない(visible: false)組み合わせは必須(required: true)にできません
  • 表示しない組み合わせのアクション詳細項目は、指定した案件タイプの案件アクションの入力画面と詳細画面に出なくなります。保存済みの値は消えず、一覧・CSV・取得 API では見えます。表示に戻すと元どおりに出ます
  • 必須は画面の入力時に効きます。アクションの登録・更新 API では、表示・必須は検査されません
  • ドメインでアクション詳細項目が利用可能になっていない場合、紐付け先設定は変更できず、値を変える組み合わせを送ると 403 になります。アクションテンプレートは更新できます
  • PAT の場合、管理者設定の権限と、指定した案件タイプの案件の参照権限が必要です。紐付け先設定を送るときは、指定した案件タイプのアクションの参照権限も必要です。アクションの参照権限が無い場合、レスポンスに紐付け先設定は含まれません(TAT では権限を判定しません)
  • リクエストに記載の無いキーは無視されます
  • 目的・アクション詳細項目そのもの、取引先アクション・コンタクトアクションの設定、他の案件タイプの設定は更新されません
  • id の無い要素(追加)を含むリクエストを送り直すと、同じテンプレートがもう1件追加されます。通信の失敗などで送り直すときは、先に取得して追加済みかを確かめてください
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: actionTemplates[1].purposeIds)を文頭に付けて最初の1件を返します。アクションテンプレート、紐付け先設定の順に検査します
  • レスポンスは案件アクション設定情報と同じ形です

案件タイプを複製したときに、テンプレートも写す手順は次のとおりです。

  1. 複製元の案件タイプの案件アクション設定情報(GET /v2/action_setting/deal_action_settings/{deal_type_id})を取得する
  2. 各テンプレートから id を外す
  3. purposeIds を、種別と名前が同じ複製先の目的の ID に置き換える
  4. 複製先の案件タイプに、本APIで送る
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

Request Body schema: application/json
required
Array of objects (DealActionTemplateUpdateParam)

アクションテンプレート一覧。省略・空配列の場合は変更なし。送った要素だけが変わります

Array of objects

アクション詳細項目紐付け先設定一覧。省略・空配列の場合は変更なし。送った項目キー(itemKey)とアクション種別(pattern)の組み合わせだけが変わります

Responses

Request samples

Content type
application/json
{
  • "actionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "actionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

コンタクトアクション設定情報

コンタクトアクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を取得します。

  • レスポンスは data などで包まず、設定のオブジェクトをそのまま返します。全件を1回で返し、ページングはありません
  • 結果は、編集してコンタクトアクション設定情報更新(PATCH /v2/action_setting/contact_action_setting)に送れます
  • アクションテンプレート(contactActionTemplates)は、アクションの入力画面でテンプレートを選ぶと事前メモ(preNote)・実施結果(result)に差し込まれる文章です。紐付くアクション種別(patterns)のアクションで選べます
  • 紐付け先設定(actionCustomItemScopeSettings)は、コンタクトアクションの入力画面でのアクション詳細項目の表示・必須です。アクションの登録・更新 API では検査されません
  • 紐付け先設定は、アクション詳細項目ごとにアクション種別1〜5の5件を返します。並びはアクション設定(GET /v2/action_setting)のアクション詳細項目と同じで、項目ごとにアクション種別の昇順です。一度も設定していない組み合わせは、表示・必須とも false になります
  • アクション詳細項目は項目キー(itemKey)で指します。項目名・項目タイプ・選択肢はアクション設定(GET /v2/action_setting)で取得できます
  • 取引先アクションのアクションテンプレートと紐付け先設定は、取引先アクション設定情報(GET /v2/action_setting/customer_action_setting)で取得できます
  • ドメインでアクション詳細項目が利用可能になっていない場合、紐付け先設定は含まれません。アクションテンプレートは返します
  • ドメインでラベルタイプが利用可能になっていない場合、ラベルタイプの項目の紐付け先設定は含まれません
  • PAT の場合、権限設定を利用しているドメインではコンタクトアクションの保存権限が無いと 403 になります
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "contactActionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

コンタクトアクション設定情報更新

コンタクトアクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を更新します。

1回のリクエストで、テンプレートの追加・変更・削除と、紐付け先設定の変更をまとめて送れます。送った要素だけが変わります。

したいこと 要素の書き方
テンプレートを追加 contactActionTemplates に、id を付けずに name と patterns を送る
テンプレートを変更 contactActionTemplates に、id と変えるキーだけを送る(省いたキーは変わらない)
テンプレートを削除 contactActionTemplates に、id と deleted: true を送る
表示・必須を変える actionCustomItemScopeSettings に、itemKey・pattern・visible・required の4つを送る(4つとも必須)

リクエストの例は、ID 21 のテンプレートの名前を変え、ID 22 のテンプレートの種別をメール・電話にし、ID 23 のテンプレートを削除し、電話のテンプレートを1件追加します。あわせて、項目 visit_purpose を電話で必須にします。

  • コンタクトアクション設定情報(GET /v2/action_setting/contact_action_setting)の結果を編集して送れます。そのまま送ると何も変わりません
  • アクションテンプレート(contactActionTemplates)・紐付け先設定(actionCustomItemScopeSettings)とも、省略・空配列は変更なしです。テンプレートを全件削除するときは、各要素に削除の指定(deleted: true)を付けます
  • テンプレートの削除は元に戻せません。削除しても、既存のアクションに差し込まれた事前メモ・実施結果は変わりません
  • 種別(patterns)は送った一覧で置き換えます。同じ値は1つにまとめます。空の配列は送れません(今の種別が無いテンプレートに空の配列を送ったときだけは、変更なしとして受けます)
  • 事前メモテンプレート(actionData)・実施結果テンプレート(actionPoint)の空文字は空文字のまま保存されます
  • アクションテンプレートは300件まで登録できます。超える追加は400になります。同じリクエストで削除した分は追加できます
  • 紐付け先設定は、項目キー(itemKey)とアクション種別(pattern)の組み合わせで指定し、送った組み合わせだけが変わります。項目キーはアクション設定(GET /v2/action_setting)で取得できます
  • 表示しない(visible: false)組み合わせは必須(required: true)にできません
  • 表示しない組み合わせのアクション詳細項目は、コンタクトアクションの入力画面と詳細画面に出なくなります。保存済みの値は消えず、一覧・CSV・取得 API では見えます。表示に戻すと元どおりに出ます
  • 必須は画面の入力時に効きます。アクションの登録・更新 API では、表示・必須は検査されません
  • ドメインでアクション詳細項目が利用可能になっていない場合、紐付け先設定は変更できず、値を変える組み合わせを送ると 403 になります。アクションテンプレートは更新できます
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • リクエストに記載の無いキーは無視されます
  • アクション詳細項目そのもの、取引先アクション・案件アクションの設定は更新されません
  • id の無い要素(追加)を含むリクエストを送り直すと、同じテンプレートがもう1件追加されます。通信の失敗などで送り直すときは、先に取得して追加済みかを確かめてください
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: contactActionTemplates[1].patterns)を文頭に付けて最初の1件を返します。アクションテンプレート、紐付け先設定の順に検査します
  • レスポンスはコンタクトアクション設定情報と同じ形です
Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects (ContactActionTemplateUpdateParam)

コンタクトアクションテンプレート一覧。省略・空配列の場合は変更なし。送った要素だけが変わります

Array of objects

アクション詳細項目紐付け先設定一覧。省略・空配列の場合は変更なし。送った項目キー(itemKey)とアクション種別(pattern)の組み合わせだけが変わります

Responses

Request samples

Content type
application/json
{
  • "contactActionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "contactActionTemplates": [
    ],
  • "actionCustomItemScopeSettings": [
    ]
}

アクション詳細項目登録

アクション詳細項目を登録します。

項目タイプ(itemType)によって送るキーが変わります。リクエストの例を項目タイプごとに載せています。

項目タイプ 選択肢(actionCustomItemOptions) 表示形式(uiMode)
single_select 1件以上が必須 1(プルダウン)・2(ラジオボタン)。省略すると2
multi_select 1件以上が必須 1(プルダウン)・3(チェックボックス)。省略すると3
上記以外 送らない 送らない(読まれず null になります)
  • レスポンスは data などで包まず、登録したアクション詳細項目をそのまま返します。形はアクション設定の取得(GET /v2/action_setting)の要素と同じで、紐付け先設定は含みません
  • before に既存の項目キーを渡すと、その項目の直前に挿入されます
  • 選択肢の value を省略すると、選択肢IDと同じ値になります
  • 紐付け先設定(actionCustomItemScopeSettings)を省略すると、取引先・コンタクト・登録時点の全案件タイプのアクションで、全アクション種別に表示されます。項目を追加する前に、どの登録先・アクション種別で使うかを決めて指定してください
  • 紐付け先設定を指定すると、指定した登録先・アクション種別だけで表示されます。ただし、PAT の場合、実行ユーザーにアクションの参照権限が無い案件タイプでは、指定しなくても表示されたままになります
  • 案件タイプIDは案件タイプ一覧の取得(GET /v2/deal_setting/deal_types)で調べます。別の環境へ移すときは、移行先の案件タイプIDに置き換えてください
  • アクション設定の取得結果の要素は、項目名・項目キーを変えればそのまま送れます。リクエストに無いキーは無視されます
  • 必須は画面でアクションを入力するときに効きます。アクションの登録・更新 API では表示・必須はチェックされません
  • 同じ項目名・項目キーの項目は作れないため、同じ内容で再送すると 400 になります
  • 詳細項目数・1項目あたりの選択肢数には、ドメインごとの上限があります。超える場合は 400 になり、messages に上限数が入ります(例: 詳細項目の登録上限数を超えています(上限数: 30))
  • エラーがあった場合、項目・選択肢・紐付け先設定は何も作られません
  • ドメインでアクション詳細項目が利用可能になっていない場合は 403 になります
  • ドメインでラベルタイプが利用可能になっていない場合、itemType に label は指定できません
  • 取引先アクションの入力画面での表示・必須(紐付け先設定)は、登録後に取引先アクション設定情報更新(PATCH /v2/action_setting/customer_action_setting)で変更できます
  • 案件アクションの入力画面での表示・必須(紐付け先設定)は、登録後に案件タイプごとに案件アクション設定情報更新(PATCH /v2/action_setting/deal_action_settings/{deal_type_id})で変更できます
  • コンタクトアクションの入力画面での表示・必須(紐付け先設定)は、登録後にコンタクトアクション設定情報更新(PATCH /v2/action_setting/contact_action_setting)で変更できます
  • PAT 認証の場合は管理者設定の権限が必要です。紐付け先設定で指定する案件タイプには、アクションの参照権限が必要です(TAT 認証では権限判定を行いません)
  • このAPIを使って登録した場合、PAT認証時のみ監査ログが記録されます
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string <= 255 characters

項目名(255文字以内)。ドメイン内で一意。前後の空白(全角を含む)は除いて保存されます

itemKey
string <= 255 characters

項目キー(半角英数字と _ で255文字以内。ドメイン内で一意)。省略した場合は自動で採番されます

itemType
required
string
Enum: "text" "date" "single_select" "multi_select" "url" "decimal_number" "label"

アクション詳細項目タイプ。

  • text: テキスト
  • date: 日付
  • single_select: 単一選択
  • multi_select: 複数選択
  • url: URL
  • decimal_number: 数値(小数点あり)
  • label: ラベル

label はドメインでラベルタイプが利用可能な場合のみ指定できます。

before
string

指定した項目キーの手前に項目を追加します。省略した場合は末尾に追加されます

Array of objects (ActionCustomItemOptionInput)

選択肢一覧。itemType が single_select / multi_select の場合に1件以上指定します

uiMode
integer or null

表示形式。itemType が single_select の時は 1・2、multi_select の時は 1・3 を指定できます。 省略・null の場合は single_select は 2、multi_select は 3 になります。その他の itemType では読まれず、null になります

  • 1 - プルダウン
  • 2 - ラジオボタン
  • 3 - チェックボックス
Array of objects or null (ActionCustomItemScopeSettingInput)

アクション詳細項目紐付け先設定。登録先(取引先・案件タイプごとの案件・コンタクト)とアクション種別の組み合わせごとに、入力画面での表示・必須を指定します。 指定した組み合わせだけが指定どおりになり、指定しなかった組み合わせは表示されません(空配列ではどこにも表示されません)。 ただし、PAT の場合、実行ユーザーにアクションの参照権限が無い案件タイプの組み合わせは、指定しなくても「表示する・必須にしない」で作られます。 省略・null の場合は、取引先・コンタクト・登録時点の全案件タイプの全アクション種別で「表示する・必須にしない」になります

Responses

Request samples

Content type
application/json
Example
{
  • "name": "訪問メモ",
  • "itemKey": "visit_memo",
  • "itemType": "text"
}

Response samples

Content type
application/json
{
  • "id": 101,
  • "name": "商談の温度感",
  • "itemType": "single_select",
  • "itemKey": "temperature",
  • "uiMode": 1,
  • "actionCustomItemOptions": [
    ]
}

アクション詳細項目更新

アクション詳細項目を更新します。

送ったキーだけが変わります。操作ごとのリクエストの例を載せています。

したいこと 送り方
項目名を変える name に新しい項目名を送る
項目キーを変える newItemKey に新しい項目キーを送る
選択肢名を変える actionCustomItemOptions に、変える選択肢の value と新しい label を送る
選択肢を追加する actionCustomItemOptions に、どの選択肢とも一致しない value と label を送る
選択肢を削除する actionCustomItemOptions に、value と delete: true を送る
選択肢の値を変える actionCustomItemOptions に、value と新しい値の newValue を送る
並び位置を変える before に、手前に置く項目の項目キーを送る(null・空文字で末尾)
表示形式を変える uiMode を送る(単一選択・複数選択の項目だけ)
  • 項目タイプ(itemType)は変更できません
  • 選択肢は value で既存の選択肢を特定します。newValue で選択肢の値(value)そのものを変え、delete に true を指定すると削除します。value が既存の選択肢と一致しない場合は新しい選択肢として追加されます。追加するときは value を指定してください
  • 送った選択肢は、送った順に並びます。送らなかった選択肢は今の位置のまま残ります。全部の並びを決めるときは、全部の選択肢を送ってください
  • 選択肢の value・newValue は整数で送ります。真偽値を送ると 400 になり、messages に誤りのある場所(例: actionCustomItemOptions[0].value)が付きます。actionCustomItemOptions に配列でなく、選択肢を持つオブジェクトを送ると 400 になります。文字列・数値などは読まれず、選択肢は変わりません
  • 選択肢名(label)に数値を送ると、文字列にして保存されます
  • 選択肢を削除すると、その選択肢を選んでいたアクションの値も消え、元に戻せません。オートメーションの条件などから参照されていても削除されます
  • 選択肢を削除する前に、その選択肢を選んでいるアクションの件数を確認する手段はありません
  • 選択肢を変更する場合は、ドメインの詳細項目数・1項目あたりの選択肢数の上限を超えると 400 になり、messages に上限数が入ります
  • 選択肢の値(value)が null の選択肢は value で特定できません。取得結果をそのまま送ると、新しい選択肢の追加として扱われて400になるため、その項目では選択肢を送らずに更新してください
  • 表示形式(uiMode)は単一選択・複数選択の項目だけが対象です。ほかの項目タイプに送っても読まれません
  • 並び位置は before に、手前に置く項目の項目キーを指定します。並び順は取引先・案件・コンタクトの全登録先、全アクション種別で共通です
  • ラベル型の項目のラベルは、このAPIでは名前の変更・削除ができません。ラベルはアクション詳細項目ラベルリスト(GET /v2/action_custom_items/{actionCustomItemKey}/labels)で確認できます
  • 紐付け先設定は変更できません。表示・必須は、取引先アクション設定情報更新(PATCH /v2/action_setting/customer_action_setting)・案件アクション設定情報更新(PATCH /v2/action_setting/deal_action_settings/{deal_type_id})・コンタクトアクション設定情報更新(PATCH /v2/action_setting/contact_action_setting)で変更します
  • 項目の削除はアクション詳細項目削除(DELETE /v2/action_custom_items/{item_key})で行います
  • 取得結果に含まれる、このAPIが読まないキー(id・itemKey・itemType・選択肢の id)は無視されます
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • レスポンスは data などで包まず、更新したアクション詳細項目をそのまま返します。形はアクション設定の取得(GET /v2/action_setting)の要素と同じです
Authorizations:
bearer_auth
path Parameters
item_key
required
string

項目キー

Request Body schema: application/json
required
name
string <= 255 characters

項目名(255文字以内)。ドメイン内で一意。前後の空白(全角を含む)は除いて保存されます

newItemKey
string <= 255 characters

新しい項目キー(半角英数字と _ で255文字以内。ドメイン内で一意)。空文字は変更なしとして扱います。項目キーを変更した場合、元の項目キーの値を前提とした処理が動作しなくなる可能性があります。

Array of objects (ActionCustomItemOptionUpdateParam)

選択肢の一覧。送った選択肢は、送った順に並びます。送らなかった選択肢は今の位置のまま残ります。全部の並びを決めるときは、全部の選択肢を送ってください

uiMode
integer or null

表示形式。itemType が single_select の時は 1・2、multi_select の時は 1・3 を指定できます。 省略した場合は変更されません。設定済みの表示形式を null にすることはできません。その他の itemType では読まれません

  • 1 - プルダウン
  • 2 - ラジオボタン
  • 3 - チェックボックス
before
string or null

指定した項目キーの手前に項目を移動します。省略した場合は位置を変更せず、null・空文字の場合は末尾に移動します

Responses

Request samples

Content type
application/json
Example
{
  • "name": "商談の温度感(改)",
  • "newItemKey": "deal_temperature",
  • "uiMode": 2,
  • "before": null,
  • "actionCustomItemOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "itemType": "text",
  • "itemKey": "string",
  • "uiMode": 0,
  • "actionCustomItemOptions": [
    ]
}

アクション詳細項目削除

アクション詳細項目を削除します。

  • 項目を消すと、選択肢・ラベル・紐付け先設定と、アクションに入力済みの値も消えます。元に戻せません
  • 成功時は 200 を返し、レスポンスの本文はありません
  • 他ドメイン・存在しない項目キーを指定した場合は 404 になります
  • ドメインでアクション詳細項目が利用可能になっていない場合は 403 になります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
Authorizations:
bearer_auth
path Parameters
item_key
required
string

項目キー

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

アクション詳細項目ラベルリスト

ラベル型のアクション詳細項目に登録されているラベルの一覧を取得します。

  • 指定したキーのアクション詳細項目が存在しない場合は 404 を返します
  • page / limit によるページングに対応しています
  • ドメインでアクション詳細項目が利用可能になっていない場合は 403 になります
  • 権限は判定しません(PAT・TAT とも、ドメインのアクション詳細項目ラベルを取得できます)
Authorizations:
bearer_auth
path Parameters
actionCustomItemKey
required
string

アクション詳細項目の項目キー

query Parameters
searchWord
string

指定した文字列と部分一致するラベルを検索します。

sort
string

並び順。name(ラベル名の昇順)・-name(降順)を指定できます。省略時とほかの値では name になります

page
integer

ページ番号(1始まり)。未指定時は1ページ目

limit
integer

取得件数(1〜1000、デフォルト100)

Responses

Response samples

Content type
application/json
{
  • "actionCustomItemKey": "string",
  • "totalCount": 0,
  • "page": 0,
  • "labels": [
    ]
}

取引先(Customers)

取引先情報リスト

取引先一覧をカーソルページネーション形式で取得します。

  • レスポンスは v1同様の customers キー ({ customers, hasMore, nextCursor, totalCount })
  • v1 GET /api/v1/customers と互換のあるデータを、v2 形式で提供します
Authorizations:
bearer_auth
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

searchWord
string

指定した文字列と取引先名が部分一致する取引先を検索します。

updatedAtFrom
string <date-time>

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>

更新日時による検索範囲(終了)

  • ex) 2018-04-01T10:30:00
sort
string
Default: "-updated_at"
Enum: "updated_at" "-updated_at" "created_at" "-created_at" "updatedAt" "-updatedAt" "createdAt" "-createdAt"

並び順 ソート可能 updatedAt、createdAt

itemKeyAsPropertyKey
string
Enum: "true" "false"

true の場合、customerCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します

Responses

Response samples

Content type
application/json
{
  • "customers": [
    ],
  • "hasMore": true,
  • "nextCursor": "string",
  • "totalCount": 0
}

取引先情報登録

取引先を登録します。

  • 入力値の型不正は 400 BAD_REQUEST、バリデーション失敗は 400 VALIDATION_FAILED
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string

取引先名

address
string or null

住所

telNo
string or null

電話番号

webUrl
string or null

URL

employee
integer or null

従業員数

capital
integer or null

資本金

closingMonth
integer or null

決算月(1〜12)

establishYear
integer or null

設立年(西暦)。未指定の場合、取引先のWebサイトURLからMazrica登録企業が一意に特定できたときは、その企業の設立年が設定されます。

industryId
integer or null

業種ID。指定したIDに対応する業種名がレスポンスの industry.name に設定されます。取引先のWebサイトURLからMazrica登録企業が一意に特定できた場合、業種は特定された企業の主要業種で置き換えられます(特定された企業に主要業種が登録されていない場合は未設定になります)。業種IDの一覧が必要な場合はサポートへお問い合わせください。

ownerRoleId
integer or null

所有ロールID

parentId
integer or null

親取引先ID

companyNum
string or null

取引先の基本項目「法人番号」。13桁の半角数字で指定します(形式が不正な場合は 400 になります)。null や空文字を指定した場合は無視されます。

Array of objects (CustomerCustomCreateParam)

取引先詳細項目。項目は customerCustomItemId か itemKey で特定する

Array of objects (CustomObjectAssociationParam)

関連付けカスタムオブジェクト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "establishYear": 0,
  • "industryId": 0,
  • "ownerRoleId": 0,
  • "parentId": 0,
  • "companyNum": "string",
  • "customerCustoms": [
    ],
  • "customObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "companyNum": "string",
  • "establishYear": 0,
  • "industry": {
    },
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "company": {
    },
  • "closingMonth": 0,
  • "ownerRole": {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms": [
    ]
}

取引先情報検索

取引先情報を検索します。v1 POST /api/v1/customers/search と同形式の compositeFilter を受け付けます。

  • ページングは page に代えてカーソル形式 (limit / cursor / nextCursor / hasMore)。totalCount は維持
  • レスポンスのトップキーは customers(v1 互換)
  • filter / sort に指定できる標準項目は、各スキーマの説明に記載のものに限られます(それ以外は 400 になります)

filter / sort に指定できる標準項目

  • filter: id / name / address / telNo / memo / webUrl / industryId / capital / employee / establishYear / closingMonth / ownerRoleId / createdAt / updatedAt
  • sort: 上記のうち webUrl を除いたもの。省略時は updatedAt 降順(id 昇順タイブレーク)
  • companyNum は filter / sort に指定できません(指定すると 400 になります)
  • 項目名は他のパラメータと同じ camelCase で指定できます(snake_case でも受け付けます)
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
object (CustomerSearchFilter)

絞り込み条件

  • compositeFilter と valueFilter を合わせて最大300個まで指定できます(最上位の compositeFilter は件数に含まれません)。
object (CustomerSearchSort)

並び替え条件。省略時は updated_at 降順(id 昇順タイブレーク)。

limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

itemKeyAsPropertyKey
string
Enum: "true" "false"

true の場合、customerCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": {
    },
  • "limit": 100,
  • "cursor": "string",
  • "itemKeyAsPropertyKey": "true"
}

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "nextCursor": "string",
  • "hasMore": true,
  • "customers": [
    ]
}

取引先情報

取引先情報を取得します。

  • include_related_objects=1 を指定するとカスタムオブジェクト連携情報(customObjects)を含みます
Authorizations:
bearer_auth
path Parameters
id
required
integer

取引先ID

query Parameters
itemKeyAsPropertyKey
string
Enum: "true" "false"

true の場合、customerCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します

include_related_objects
integer
Default: 0

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "companyNum": "string",
  • "establishYear": 0,
  • "industry": {
    },
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "closingMonth": 0,
  • "capital": 0,
  • "company": {
    },
  • "ownerRole": {
    },
  • "customerCustoms": [
    ],
  • "customObjects": [
    ],
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00"
}

取引先情報更新

  • 取引先情報を更新します。リクエストに含まれた項目のみ更新されます(部分更新)。
  • 業種は industryId によるIDの直接指定に加え、{ "industry": { "id": 1 } } 形式でも指定できます。
  • industryId / establishYear は null を指定すると未設定になります。一方 companyNum は null や空文字を指定しても既存値は削除されません。
Authorizations:
bearer_auth
path Parameters
id
required
integer

取引先ID

Request Body schema: application/json
required
name
string

取引先名

address
string or null

住所

telNo
string or null

電話番号

webUrl
string or null

URL

employee
integer or null

従業員数

capital
integer or null

資本金

closingMonth
integer or null

決算月(1〜12)

establishYear
integer or null

設立年(西暦)。null を指定すると未設定になります。

industryId
integer or null

業種ID。指定したIDに対応する業種名がレスポンスの industry.name に設定されます。null を指定すると未設定になります。業種IDの一覧が必要な場合はサポートへお問い合わせください。

object or null

業種。industryId の代わりに { "id": 1 } 形式でも指定できます。オブジェクトで指定した場合は industryId より優先されます(null を指定した場合は industryId の値が使われます)。id を含まないオブジェクト({} など)を指定した場合は、industryId を併記していても業種は未設定になります。

ownerRoleId
integer or null

所有ロールID

companyNum
string or null

取引先の基本項目「法人番号」。13桁の半角数字で指定します(形式が不正な場合は 400 になります)。null や空文字を指定した場合は無視されます。(既存値は削除されません)

Array of objects

取引先詳細項目

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "establishYear": 0,
  • "industryId": 0,
  • "industry": {
    },
  • "ownerRoleId": 0,
  • "companyNum": "string",
  • "customerCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "companyNum": "string",
  • "establishYear": 0,
  • "industry": {
    },
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "company": {
    },
  • "closingMonth": 0,
  • "ownerRole": {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms": [
    ]
}

取引先情報削除

指定した取引先を削除します。

  • 成功時はレスポンスボディなしで 200 を返す(v1同様)
  • 取引先に設定された案件・コンタクト・アクションも全て削除されます。関連取引先として設定されている案件は削除されず、紐付けが解除されます
Authorizations:
bearer_auth
path Parameters
id
required
integer

取引先ID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

取引先一括登録

取引先を一括登録します(v1同様の同期実行)。

  • 成功時は作成した取引先IDの配列を返します
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です。
  • このAPIを使って登録した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)。
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (CustomerBulkCreateItem) <= 1000 items

登録する取引先の配列

Responses

Request samples

Content type
application/json
{
  • "customers": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

取引先一括更新

取引先を一括更新します(v1同様の同期実行)。

  • 成功時は更新した取引先IDの配列を返します
  • 指定しなかった項目は更新されません
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です。
  • 同じ取引先IDを複数行に指定した場合は最後の行が採用されます
  • このAPIを使って更新した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)。
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (CustomerBulkUpdateItem) <= 1000 items

更新する取引先の配列

Responses

Request samples

Content type
application/json
{
  • "customers": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

取引先アクション(CustomerActions)

取引先アクション情報リスト

指定した取引先に紐づくアクション一覧をカーソルページネーション形式で取得します。

  • レスポンスは v1 と同じエンベロープ({ totalCount, nextCursor, hasMore, actions })。v1 の page はカーソルページネーションに置き換え
  • v1 互換: customer_id に all を指定すると全取引先のアクションを対象とする
  • 指定したcustomer_idが存在しない場合は 404
  • 指定したcustomer_idへの参照権限がない場合は 403
  • 取引先アクション参照 権限が無い場合は 403 ではなく 200 + 空配列を返す
Authorizations:
bearer_auth
path Parameters
required
integer or string

取引先IDを指定してアクションを検索します。

取引先IDの代わりに、allと指定することで取引先IDを跨いだアクションの取得が可能です。

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

sort
string
Default: "-startDatetime"
Enum: "startDatetime" "-startDatetime" "start_datetime" "-start_datetime"

並び順 ソート可能 startDatetime

startDatetime
string <date-time>
Example: startDatetime=2018-04-01T10:30:00+09:00

開始日時

ex)

  • startDatetime=2019-01-01T09:00:00+09:00
  • endDatetime=2019-01-01T11:00:00+09:00

上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00(JST)のアクションを検索します。

日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: 2019-01-01T00:00:00Z または JST: 2019-01-01T09:00:00+09:00)。省略時はUTCとして解釈されます。

endDatetime
string <date-time>
Example: endDatetime=2018-04-01T10:30:00+09:00

終了日時

ex)

  • startDatetime=2019-01-01T09:00:00+09:00
  • endDatetime=2019-01-01T11:00:00+09:00

上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00(JST)のアクションを検索します。

日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: 2019-01-01T00:00:00Z または JST: 2019-01-01T09:00:00+09:00)。省略時はUTCとして解釈されます。

createdAtFrom
string <date-time>
Example: createdAtFrom=2018-04-01T10:30:00+09:00

登録日時開始時間

ex)

  • createdAtFrom=2019-01-01T09:00:00+09:00
  • createdAtTo=2019-01-01T11:00:00+09:00

上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。

日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: 2019-01-01T00:00:00Z または JST: 2019-01-01T09:00:00+09:00)。省略時はUTCとして解釈されます。

createdAtTo
string <date-time>
Example: createdAtTo=2018-04-01T10:30:00+09:00

登録日時終了時間

ex)

  • createdAtFrom=2019-01-01T09:00:00+09:00
  • createdAtTo=2019-01-01T11:00:00+09:00

上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。

日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: 2019-01-01T00:00:00Z または JST: 2019-01-01T09:00:00+09:00)。省略時はUTCとして解釈されます。

updatedAtFrom
string <date-time>
Example: updatedAtFrom=2018-04-01T10:30:00+09:00

最終更新日時開始時間

ex)

  • updatedAtFrom=2019-01-01T09:00:00+09:00
  • updatedAtTo=2019-01-01T11:00:00+09:00

上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。

日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: 2019-01-01T00:00:00Z または JST: 2019-01-01T09:00:00+09:00)。省略時はUTCとして解釈されます。

updatedAtTo
string <date-time>
Example: updatedAtTo=2018-04-01T10:30:00+09:00

最終更新日時終了時間

ex)

  • updatedAtFrom=2019-01-01T09:00:00+09:00
  • updatedAtTo=2019-01-01T11:00:00+09:00

上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。

日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: 2019-01-01T00:00:00Z または JST: 2019-01-01T09:00:00+09:00)。省略時はUTCとして解釈されます。

users[][id]
Array of integers

アクション担当者、その他の担当者を検索します。

GETパラメータで指定する場合、以下の形式で指定します。

?users[][id]=1&users[][id]=2

pattern
integer

アクションの種別

active
string
Enum: "true" "false"

true:予定 false:完了

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "nextCursor": "string",
  • "hasMore": true,
  • "actions": [
    ]
}

取引先アクション登録

取引先アクションを新規登録します。

  • pattern、startDatetime、endDatetime、creator は必須
  • 関連リソースID(creator / invitees / contacts)が存在しない・別ドメインの場合は 404
Authorizations:
bearer_auth
path Parameters
customer_id
required
integer

取引先ID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
Request Body schema: application/json
required
object

アクション種別

startDatetime
required
string <date-time>

開始日時

endDatetime
required
string <date-time>

終了日時

required
object

アクション担当者ID

Array of objects

他の担当者

Array of objects

アクションコンタクト

preNote
string or null

アクションの事前メモ

result
string or null

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)。false で完了アクションとして登録します。

Array of objects

アクション詳細項目一覧

Responses

Request samples

Content type
application/json
{
  • "pattern": {
    },
  • "startDatetime": "2019-08-24T14:15:22Z",
  • "endDatetime": "2019-08-24T14:15:22Z",
  • "creator": {
    },
  • "invitees": [
    ],
  • "contacts": [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "actionCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "string",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "customer": {
    },
  • "contacts": [
    ],
  • "actionCustoms": [
    ]
}

取引先アクション情報

  • アクション情報を取得
Authorizations:
bearer_auth
path Parameters
customer_id
required
integer

取引先ID

id
required
integer

アクションID

query Parameters
include_files
integer

1 を指定すると、添付ファイルの情報を含めて返します。

Responses

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "id": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "customer": {
    },
  • "contacts": [
    ],
  • "actionCustoms": [
    ]
}

取引先アクション情報更新

取引先アクションを更新します。

  • 指定したフィールドのみ更新します(部分更新)
  • invitees を指定した場合は全量置き換えになります
Authorizations:
bearer_auth
path Parameters
customer_id
required
integer

取引先ID

id
required
integer

アクションID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
Request Body schema: application/json
object

アクション種別

startDatetime
string <date-time>

開始日時

endDatetime
string <date-time>

終了日時

object

アクション担当者ID

preNote
string or null

アクションの事前メモ

result
string or null

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

Array of objects

他の担当者

Array of objects

アクションコンタクト

Array of objects

アクション詳細項目一覧

Responses

Request samples

Content type
application/json
{
  • "pattern": {
    },
  • "startDatetime": "2019-08-24T14:15:22Z",
  • "endDatetime": "2019-08-24T14:15:22Z",
  • "creator": {
    },
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "invitees": [
    ],
  • "contacts": [
    ],
  • "actionCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "string",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "customer": {
    },
  • "contacts": [
    ],
  • "actionCustoms": [
    ]
}

取引先アクション情報削除

  • アクション情報を削除
  • 削除成功時はレスポンスボディなし(200 OK)
Authorizations:
bearer_auth
path Parameters
customer_id
required
integer

取引先ID

id
required
integer

アクションID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

取引先アクション一括登録

取引先アクションを一括登録します。

  • 一度に登録可能な上限は1000件です
  • 1件でもエラーがある場合は全件登録されません
  • このAPIを使って登録した場合、監査ログは記録されません
Authorizations:
bearer_auth
query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 本エンドポイント(一括登録/更新)はそもそも通知を送信しないため、指定しても効果はありません。
  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱いで、400にはなりません。
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

案件設定(DealSetting)

案件タイプリスト

案件タイプの一覧を取得します。

  • ページングはありません(全件を配列で返します)
  • PAT では、権限設定を利用しているドメインで閲覧権限のある案件タイプだけを返します。TAT ではすべての案件タイプを返します
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

案件タイプ登録

案件タイプを、フェーズ・商品・契約確度・チャネル・最終・停止フェーズ理由・アクション目的・取引先タイプ・カラーラベルと、 基本項目の説明と合わせて登録します。

  • 案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})の結果をそのまま送ると、同じ構成の案件タイプが作られます。リクエストのスキーマに無いキー(各要素の id、proposalTypes、dealCustomItems、dealRequiredFields など)は、送っても無視します
  • 契約確度名は nameWithoutPercentage で指定します。取得結果の name(確度掛け機能が有効な場合は割合付き)は使用しません
  • カラーラベルの色(colorCode)は指定できません。並び順の位置ごとの初期値になります
  • 画面で作れない構成(受注フェーズが1件でない、カラーラベルが3件でない、経過日数の区間が連続しない等)は400になります。取得結果でも、この構成に当たるものは登録できません
  • 確度掛け機能が無効な場合、割合(percentage)を省略・null にした契約確度は割合0で作られます
  • 取引先タイプは、関連取引先機能が有効なドメインでのみ指定できます
  • 新しい案件タイプは一覧の先頭に入り、他の案件タイプの並び順は1つずつ後ろにずれます。そのため、先頭の案件タイプを既定として使う画面の初期値も新しい案件タイプに変わります
  • 利用する提案タイプ・フェーズ毎の必須項目・案件詳細項目は登録されません。複製するときは、下の「複製の手順」で登録の後に設定します
  • 新しい案件タイプでは、既存のアクション詳細項目はすべて表示されない設定になります
  • 実行ユーザーのロールには、取引先の参照権限と同じ値で新しい案件タイプの権限が付きます。取引先の参照権限が無いロールでは、作成した案件タイプを取得できません
  • 同じ内容を再送すると、同じ構成の案件タイプがもう1件作られます
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 入力エラーの messages には、<場所>: <理由> の形で最初の1件だけが入ります(例: phases[1].name: 値を指定してください)。場所の添字は0始まりで、送った配列の位置です
  • レスポンスは案件タイプ設定情報と同じ形です

初期値

一覧を省略するか null を指定すると、画面で案件タイプを追加したときと同じ初期値で作られます。説明(description)は付きません。空配列を指定すると、最終・停止フェーズ理由・アクション目的・取引先タイプは0件で作られ、フェーズ・商品・契約確度・チャネルは400になります。

一覧 省略・null のときに作られるもの
phases 進行中: リード・アプローチ・ヒアリング・プレゼンテーション・クロージング/受注: 受注/失注: 失注・保留
products 商品1・商品2
probabilities A・B・C・D・E(割合はすべて100)
channels テレアポ・Web問合せ・電話問合せ・セミナー・展示会・紹介
actionsPurposes 面談: 自社紹介・ヒアリング・興味喚起・提案・懸念払拭・クロージング・関係構築/メール: アポ取り・興味喚起・確認・懸念払拭・提案・クロージング/電話: アポ取り・興味喚起・確認・懸念払拭・提案・クロージング/社内タスク: 社内ミーティング・提案書作成・見積書作成・調査/社外タスク: パートナー打合せ・パートナー同行依頼・パートナータスク依頼・第三者ヒアリング
dealSearchActionRanges 1週間以内(0〜7日)・1週間~1ヶ月(8〜30日)・1ヶ月以上(31〜365日)
endPhaseReasons 0件
dealCustomerTypes 0件

複製の手順

  1. 複製元を案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})で取得し、その結果を本APIに送ります
  2. 複製元が商品内訳を使っているときは、複製元に紐付いた商品内訳設定(商品内訳設定リスト(GET /v2/deal_product_detail_types)の dealTypeIds に複製元のIDがあるもの)の dealTypeIds に複製先のIDを足して、商品内訳設定一括更新(PATCH /v2/deal_product_detail_types/bulk)で送ります。紐付けないと、商品内訳を参照する数式を作れません
  3. 複製元の案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)の layout にある案件詳細項目グループを、後ろから順に、案件詳細項目グループ設定情報登録(POST /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_item_groups)で複製先に作ります。複製先の deal_type_id は、手順1の本APIのレスポンスの id です。1つ目は before を省略し、2つ目以降は直前に作ったグループの登録のレスポンスの id を before に指定すると({"dealCustomItemGroupId": 直前に作ったグループの id})、複製元と同じ並びになります
  4. 案件詳細項目を、式(四則演算・数式)以外の案件詳細項目、式の案件詳細項目の順に、案件詳細項目設定情報登録(POST /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で作ります。所属する案件詳細項目グループID(dealCustomItemGroupId)・並び位置(before)・式の参照先(modelId)は、複製先のIDに置き換えます。グループのIDは手順3のグループの登録のレスポンスの id、案件詳細項目のIDはこの手順で先に作った案件詳細項目の登録のレスポンスの id です。before には、複製元の並びでその案件詳細項目より後ろにある作成済みの要素のうち最も前のものを指定し、無いときは省略します(詳しくは案件詳細項目設定情報登録の「複製の手順」を参照してください)
  5. 作った案件タイプを案件タイプ設定情報で取得し、フェーズIDと案件詳細項目IDを複製先のIDに置き換えて、フェーズ毎の必須項目(dealRequiredFields)と利用する提案タイプ(proposalTypes)を案件タイプ更新(PATCH /v2/deal_setting/deal_types/{id})で送ります。必須の案件詳細項目は、手順4で複製先に作った後でなければ指定できません。商品内訳の必須(dealProductDetail)は、手順2で dealTypeIds の後ろに足した複製先には付けられず400になるため、外して送ります(商品内訳の必須を付けられるのは、dealTypeIds の先頭の案件タイプだけです)
  6. 複製元の案件アクション設定情報(GET /v2/action_setting/deal_action_settings/{deal_type_id})の結果から、アクションテンプレートの id を外し、目的の ID(purposeIds)を、種別と名前が同じ複製先のアクション目的の ID に置き換えて、案件アクション設定情報更新(PATCH /v2/action_setting/deal_action_settings/{deal_type_id})で複製先に送ります。アクション詳細項目の紐付け先設定も同じリクエストで送れます
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters

案件タイプ名(100文字以内)

enableContractAccuracy
boolean or null

確度掛け機能(true=有効、false=無効)。省略・null の場合は無効

enableDealProductDetailUnitCost
boolean or null

原価表示(true=有効、false=無効)。省略・null の場合は無効

Array of objects or null non-empty

フェーズ一覧。省略・null の場合は初期値。受注フェーズはちょうど1件、進行中・失注は1件以上とし、並び順で進行中・受注・失注の順に並べる

Array of objects or null non-empty

商品一覧。省略・null の場合は初期値

Array of objects or null non-empty

契約確度一覧。省略・null の場合は初期値

Array of objects or null non-empty

チャネル一覧。省略・null の場合は初期値

Array of objects or null

最終・停止フェーズ理由一覧。省略・null・空配列の場合は0件

Array of objects or null

アクション目的一覧。省略・null の場合は初期値、空配列の場合は0件

Array of objects or null

取引先タイプ一覧。省略・null・空配列の場合は0件。関連取引先機能が無効なドメインでは空配列以外を指定できません

Array of objects or null = 3 items

カラーラベル一覧。省略・null の場合は初期値。3件で、並び順の昇順に経過日数の区間を0から連続させる

Array of objects or null

基本項目設定。指定しない項目は説明なし

Responses

Request samples

Content type
application/json
{
  • "name": "新規営業",
  • "enableContractAccuracy": true,
  • "phases": [
    ],
  • "products": [
    ],
  • "probabilities": [
    ],
  • "channels": [
    ],
  • "endPhaseReasons": [
    ],
  • "dealBasicFieldSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "phases": [
    ],
  • "products": [
    ],
  • "probabilities": [
    ],
  • "channels": [
    ],
  • "endPhaseReasons": [
    ],
  • "actionsPurposes": [
    ],
  • "dealCustomItems": [
    ],
  • "dealRequiredFields": [
    ],
  • "dealCustomerTypes": [
    ],
  • "enableContractAccuracy": true,
  • "enableDealProductDetailUnitCost": true,
  • "dealSearchActionRanges": [
    ],
  • "dealBasicFieldSettings": [
    ],
  • "proposalTypes": [
    ]
}

案件タイプ設定情報

案件タイプに紐づく設定情報(フェーズ・商品・契約確度・チャネル・最終・停止フェーズ理由・アクション目的・ 案件詳細項目・フェーズ毎の必須項目・取引先タイプ・カラーラベル・基本項目設定・利用する提案タイプ)と、 確度掛け機能・原価表示の有効/無効を取得します。

  • レスポンスは、{"dealType": …} のように包まず、案件タイプ設定情報のオブジェクトをそのまま返します
  • PAT では、権限設定を利用しているドメインで閲覧権限の無い案件タイプは403になります。TAT ではすべての案件タイプを取得できます
  • 商品内訳設定は返しません。商品内訳設定リスト(GET /v2/deal_product_detail_types)を利用してください
  • 案件詳細項目設定(dealCustomItems)は簡易な一覧です。式(四則演算・数式)・案件詳細項目グループ・表示形式は案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で取得してください
  • 契約確度名(name)は、確度掛け機能が有効な場合に「 - 割合%」が付きます。割合を付けない契約確度名は nameWithoutPercentage、割合を表示するときは percentage を参照してください
  • 説明(description)は、各項目を入力する人向けの補足です。入力する値の参考にしてください
  • 各要素の並び順は orderNum を参照してください
  • 利用する提案タイプ(proposalTypes)は、提案作成時の選択肢と同じ順に並びます
  • 確度掛け機能や提案機能が無効でも、保存されている設定(確度の割合・利用する提案タイプ)を返します
  • 取得結果を編集して案件タイプ更新(PATCH /v2/deal_setting/deal_types/{id})に送ると、設定を変更できます。そのまま送った場合は何も変わりません
Authorizations:
bearer_auth
path Parameters
id
required
integer

案件タイプID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "phases": [
    ],
  • "products": [
    ],
  • "probabilities": [
    ],
  • "channels": [
    ],
  • "endPhaseReasons": [
    ],
  • "actionsPurposes": [
    ],
  • "dealCustomItems": [
    ],
  • "dealRequiredFields": [
    ],
  • "dealCustomerTypes": [
    ],
  • "enableContractAccuracy": true,
  • "enableDealProductDetailUnitCost": true,
  • "dealSearchActionRanges": [
    ],
  • "dealBasicFieldSettings": [
    ],
  • "proposalTypes": [
    ]
}

案件タイプ更新

既存の案件タイプの設定を、送った設定・要素・キーだけ差分で更新します。

  • 案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})の結果を編集して送れます。そのまま送ると何も変わりません。リクエストのスキーマに無いキー(patternName、dealCustomItems など)は、送っても無視します
  • 一覧の要素は id で既存の要素を指して更新し、id を省略すると新しく作られます。削除は要素に id と deleted: true を付けて指定します
  • 一覧の省略・空配列は変更なしです。ただし、利用する提案タイプ(proposalTypes)は送った一覧と並び順に丸ごと置き換わり、空配列ですべての紐付けが外れます。フェーズ別必須入力項目の dealCustomItemIds は、そのフェーズの必須の案件詳細項目を置き換え、空配列でそのフェーズの必須がすべて外れます
  • 要素で省略したキーは変わりません。説明(description)は null で消せます
  • 保存されている値と同じ値は、今の入力の制約(文字数・改行など)に合わなくても、そのまま受け付けます。制約を確かめるのは、値を変えたときだけです
  • 既存フェーズの状態(status)は変更できません。状態を変えたいときは、新しい状態でフェーズを作ります。受注フェーズは追加・削除できず、名前と説明だけ変更できます
  • カラーラベルは追加・削除できず、色(colorCode)と並び順(orderNum)は変更できません。名前と経過日数だけ変更できます
  • 契約確度名は nameWithoutPercentage で指定します。name(確度掛け機能が有効な場合は割合付き)は使用しません。確度の割合は確度掛け機能が無効でも保存されますが、無効の間は使われません。更新の前に、案件タイプ設定情報で確度掛け機能(enableContractAccuracy)の状態を確認してください
  • 確度掛け機能が有効な場合、新しい契約確度の割合は必須です。確度の一覧を変えるとき、割合の無い契約確度があると400になります
  • 画面で作れない構成(受注フェーズが1件でない、進行中・失注のフェーズが無い、状態の順に並ばない、商品・契約確度・チャネルが0件など)は400になります
  • 削除は、フェーズ・商品・契約確度・チャネル・最終・停止フェーズ理由・アクション目的が論理削除、取引先タイプが物理削除です。次の場合は削除できず400になります
    • フェーズ・商品・契約確度・チャネル: 案件か案件登録用メールアドレス設定で使用中、またはWebフォーム機能が有効でWebフォームで使用中
    • フェーズ: 受注フェーズ
    • 契約確度: 最後の1件
    • アクション目的: アクションで使用中(削除済みのアクションを含む)
  • 最終・停止フェーズ理由は使用中でも削除できます。取引先タイプは案件で使用中でも削除でき、案件との関連も消えます
  • アクションで使用中のアクション目的は、種別(pattern)を変更できません。種別を変えたいときは、新しい種別でアクション目的を作ります。アクション目的を削除すると、アクションテンプレートとの紐付けが外れます。目標・通知・レポートの条件には残ります
  • フェーズの名前や並びを変えると、AIフォーキャストの結果に影響することがあります
  • フェーズ別必須入力項目(dealRequiredFields)は phaseId でフェーズを指し、送ったキーだけ変わります。同じリクエストで作るフェーズ・削除するフェーズは指定できません。四則演算・数式・ユーザー・ラベル表示の案件詳細項目は新たに必須にできません。商品内訳の必須は、商品内訳設定の dealTypeIds の先頭にその案件タイプを指定して紐付けた商品内訳設定がある案件タイプでだけ付けられます。dealTypeIds の2番目以降に指定しただけの案件タイプには付けられず400になります(画面のフェーズ別必須入力項目の設定と同じ条件です)
  • 利用する提案タイプは id で指定します(name は使用しません)。同じ提案タイプを複数回指定すると1件として扱います。提案がある提案タイプを外すと400になります。外すと、その案件タイプでその提案タイプの提案を新しく作れなくなります
  • 別の環境の案件タイプを再現するときは、提案タイプの id を移行先の環境の id に置き換えます。移行先の id は、移行先の案件タイプ設定情報の proposalTypes か画面で確認します
  • 取引先タイプ・フェーズ別必須入力項目・利用する提案タイプは、それぞれ関連取引先機能・必須入力項目の機能・提案機能が無効なドメインでは変更できず403になります(取得結果のまま送る場合は変更なしとして受け付けます)
  • 案件詳細項目は更新されません。原価表示を有効にしても、既存の案件の原価は再計算されません
  • id のある要素は再送しても同じ結果になります。id の無い要素は、再送するたびに新しく作られます
  • PAT の場合、管理者設定の権限と、対象の案件タイプの編集権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages には、<場所>: <理由> の形で最初の1件だけが入ります(例: products[0].deleted: 削除する要素は id と一緒に指定してください)。場所の添字は0始まりで、送った配列の位置です。送っていない既存の要素の誤りは、probabilities[id=30].percentage のように添字の代わりに [id=<ID>] で表します。使用中で削除できない場合は、使用先を含む理由を返します
  • レスポンスは案件タイプ設定情報と同じ形で、新しく作った要素の id が入ります

送り方の例

リクエストの例(Request samples)は、次のように更新します。

  • products: 商品31の名前を変え、商品Cを一覧の先頭に追加し、商品32を削除します
  • dealRequiredFields: フェーズ51の契約金額を必須にし、必須の案件詳細項目を201・205に置き換えます
  • proposalTypes: 利用する提案タイプを3・1の順に置き換えます
  • 送らなかった一覧(フェーズ・契約確度など)は変わりません

並び順(orderNum)

一覧 新しい要素で orderNum を省略・null orderNum を指定(新しい要素・既存の要素)
phases 同じ状態の先頭に入り、後ろの要素の並び順が追加した件数ぶんずれる 送った値をそのまま保存する。他の要素の並び順は変わらない
actionsPurposes 末尾に入る 同上
products・probabilities・channels・endPhaseReasons・dealCustomerTypes 先頭に入り、後ろの要素の並び順が追加した件数ぶんずれる 同上

並べ替えるときは、並べ替える一覧の全要素に、重ならない orderNum を付けて送ります。フェーズは、状態(進行中・受注・失注)の順に並ぶ値にします。

Authorizations:
bearer_auth
path Parameters
id
required
integer

案件タイプID

Request Body schema: application/json
required
name
string [ 1 .. 100 ] characters

案件タイプ名(100文字以内)

enableContractAccuracy
boolean or null

確度掛け機能(true=有効、false=無効)。null の場合は変更なし

enableDealProductDetailUnitCost
boolean or null

原価表示(true=有効、false=無効)。null の場合は変更なし

Array of objects or null

フェーズ一覧。省略・null・空配列の場合は変更なし。反映後に受注フェーズはちょうど1件、進行中・失注は1件以上とし、並び順で進行中・受注・失注の順に並べる

Array of objects or null

商品一覧。省略・null・空配列の場合は変更なし。反映後に1件以上

Array of objects or null

契約確度一覧。省略・null・空配列の場合は変更なし。反映後に1件以上

Array of objects or null

チャネル一覧。省略・null・空配列の場合は変更なし。反映後に1件以上

Array of objects or null

最終・停止フェーズ理由一覧。省略・null・空配列の場合は変更なし

Array of objects or null

アクション目的一覧。省略・null・空配列の場合は変更なし

Array of objects or null

取引先タイプ一覧。省略・null・空配列の場合は変更なし。関連取引先機能が無効なドメインでは変更できません

Array of objects or null

カラーラベル一覧。省略・null・空配列の場合は変更なし。追加・削除はできない。変更がある場合は、反映後の3件の経過日数の区間を並び順の昇順に0から連続させる

Array of objects or null

基本項目設定。指定した項目の説明だけ変わる

Array of objects or null

フェーズ毎の必須項目設定。指定したフェーズの指定したキーだけ変わる。必須入力項目の機能が無効なドメインでは変更できません

Array of objects or null

利用する提案タイプ一覧。指定した一覧と並び順に置き換え、空配列の場合はすべて外す。省略・null の場合は変更なし。提案機能が無効なドメインでは変更できません

Responses

Request samples

Content type
application/json
{
  • "products": [
    ],
  • "dealRequiredFields": [
    ],
  • "proposalTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "phases": [
    ],
  • "products": [
    ],
  • "probabilities": [
    ],
  • "channels": [
    ],
  • "endPhaseReasons": [
    ],
  • "actionsPurposes": [
    ],
  • "dealCustomItems": [
    ],
  • "dealRequiredFields": [
    ],
  • "dealCustomerTypes": [
    ],
  • "enableContractAccuracy": true,
  • "enableDealProductDetailUnitCost": true,
  • "dealSearchActionRanges": [
    ],
  • "dealBasicFieldSettings": [
    ],
  • "proposalTypes": [
    ]
}

案件タイプ削除

案件タイプを1件削除します。画面から削除したときと同じ条件で判定し、同じ処理を行います。

  • 削除は論理削除で、元に戻せません。削除した案件タイプを復元するAPIはありません
  • 次のいずれかに当たる場合は削除できず400になります。条件はこの順に判定し、最初に当たった条件と使用先(フォーム名・キャンペーン名など)を含む理由を messages に1件返します
    • ドメインに他の案件タイプが残らない(最後の1件)
    • Webフォーム機能が有効で、削除されていないWebフォームで指定されている(公開していないフォームを含む)
    • キャンペーンメール機能が有効で、キャンペーンの検索条件(除外条件を除く)で指定されている
    • 案件で使用中。先にこの案件タイプの案件を削除してください
    • 提案機能が有効で、提案タイプと紐付いている。先に案件タイプ別設定の提案タイプから紐付けを解除してください
  • 削除すると、フェーズ・商品・契約確度・チャネル・アクション目的も削除されます。通知設定・レポート設定・ロールの案件タイプ別の権限・案件の検索条件・案件登録用メールアドレス設定・商品内訳との紐付けも削除されます
  • BI連携しているドメインでは、この案件タイプのデータセットが片付けられ、関連する分析・ダッシュボードが利用できなくなります
  • フェーズのライフサイクルステージ自動更新の対応づけは削除されません(削除したフェーズは使われなくなります)。提案機能が無効な場合、提案タイプとの紐付けは外れます(提案タイプは削除されません)
  • 他の案件タイプの並び順は変わりません
  • 削除した案件タイプは、案件タイプ設定情報の一覧・取得に出なくなります。削除済みの案件タイプを再度削除すると404になります
  • PAT の場合、管理者設定の権限と、対象の案件タイプの編集権限が必要です(TAT では権限を判定しません)
  • 成功時はレスポンスボディなしで200を返します
Authorizations:
bearer_auth
path Parameters
id
required
integer

案件タイプID

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "messages": [
    ]
}

案件詳細項目設定情報

案件タイプに設定された案件詳細項目と案件詳細項目グループを、設定画面と同じ並びで取得します。

  • レスポンスは、layout を持つオブジェクトをそのまま返します
  • 案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})の案件詳細項目設定(dealCustomItems)は簡易な一覧です。式(四則演算・数式)・案件詳細項目グループ・表示形式はこのAPIで取得してください
  • layout は画面の並び順に並び、グループに入っていない案件詳細項目(dealCustomItem)と案件詳細項目グループ(dealCustomItemGroup)が混在します。グループ内の案件詳細項目は、グループの dealCustomItems にグループ内の並び順で並びます
  • 四則演算(dealCustomItemCalculations)・数式(logicalFormula)の式は部品の配列で返します。配列の順に部品をつなげると式になります。参照先は model(種類)・modelId(ID)・property(項目)で表します
  • ラベル型(itemType が label)の選択肢は、案件にラベルを付けたときに作られたラベルです。ラベルには説明がありません
  • ユーザー型(itemType が user)の選択肢は返しません。ユーザーはユーザー情報リスト取得(GET /v2/users)で取得してください
  • ドメインの設定で利用していない項目タイプ(数式・ユーザー・ラベル)の案件詳細項目は返しません。このため、案件タイプ設定情報のフェーズ毎の必須項目(dealRequiredFields の dealCustomItemIds)に、このAPIが返さない案件詳細項目IDが含まれることがあります
  • PAT では、権限設定を利用しているドメインで編集権限の無い案件タイプは403になります。TAT ではすべての案件タイプを取得できます
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

Responses

Response samples

Content type
application/json
{
  • "layout": [
    ]
}

案件詳細項目設定情報登録

案件タイプに案件詳細項目を1件、選択肢・式と合わせて登録します。

  • 案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で取得した案件詳細項目1件を、そのまま送れます。リクエストのスキーマに無いキー(各要素の id など)は、送っても無視します
  • 別の案件タイプ・環境へ同じ並びで複製するときは、下の「複製の手順」で作ります
  • 並び位置(before)を指定するとその要素の前に入り、後ろの要素は順にずれます。省略するとグループ内・グループ外の末尾に入ります
  • 選択肢の値(value)を省略すると自動で採番されます。移行・複製では複製元の値をそのまま送ります
  • 表示形式(uiMode)を省略すると、画面で作成したときと同じ表示形式(single_select はラジオボタン、multi_select はチェックボックス)になります
  • ラベル型(itemType が label)は、ラベル(customItemOptions)を空にして送ります。ラベルは、案件の登録・更新でラベル名を指定したときに作られます。案件を別の環境へ移すと、そのときにラベルも作られます
  • 案件明細を参照する式と、ドメインの設定で利用していない案件詳細項目タイプ(数式・ユーザー・ラベル)の案件詳細項目は登録できません
  • 案件詳細項目数・選択肢数がドメインの上限を超えるときは400になり、messages に上限数が入ります。案件詳細項目数の上限超過では、messages に場所が付きません
  • PAT の場合、管理者設定の権限と、対象の案件タイプの編集権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も登録されません。入力エラーの messages には、<場所>: <理由> の形で最初の1件だけが入ります(例: customItemOptions[1].label: 値を指定してください)。場所の添字は0始まりで、送った配列の位置です
  • API項目キー(itemKey)の無い内容を再送すると、同じ案件詳細項目がもう1件作られます。itemKey を指定した再送は、同じ案件タイプに同じAPI項目キーの案件詳細項目があるため400になります
  • レスポンスは案件詳細項目設定情報の案件詳細項目(dealCustomItem)と同じ形です

型ごとの送り方

型ごとの例は、リクエストの例(Request samples)で切り替えて見られます。

itemType name・itemType のほかに指定するキー
text・url・date・number・decimal_number・user itemKey・description・dealCustomItemGroupId・before(いずれも任意)
single_select・multi_select text などのキーに加えて customItemOptions・uiMode
label text などのキーに加えて uiMode(4 のみ)。customItemOptions は空配列か省略
arithmetic text などのキーに加えて dealCustomItemCalculations(必須)
logical_formula text などのキーに加えて logicalFormula(必須)

型に合わないキーのうち、uiMode は指定しても null になります。customItemOptions・logicalFormula・dealCustomItemCalculations は、空配列か省略にします(値があると400)。

式の書き方

四則演算(dealCustomItemCalculations)・数式(logicalFormula)は、式の部品を式の順に並べた配列で指定します。参照先は type を item にして model・modelId・property で、演算子・数値・括弧・関数名は type を text にして data で指定します。 SUM などの関数は、SUM( の部品に funcStart、関数を閉じる ) の部品に funcEnd を true で付けます。商品内訳・請求サイトは、この2つの部品の間にだけ置けます。

複製の手順

別の案件タイプ・環境へ同じ並びで複製する手順は次のとおりです。複製先の案件タイプに案件詳細項目・案件詳細項目グループが無い場合に、複製元と同じ並びになります。

  1. 複製元の案件タイプで案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)を呼び、layout を得ます
  2. layout にある案件詳細項目グループを、後ろから順に、複製先の案件タイプへ案件詳細項目グループ設定情報登録(POST /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_item_groups)で作ります。最初の1つは before をキーごと省きます(before に null を送ると400です)。2つ目以降は、直前に作ったグループの登録のレスポンスの id を before に指定します({"dealCustomItemGroupId": 直前に作ったグループの id})
  3. 案件詳細項目を、式(四則演算・数式)以外の案件詳細項目、式の案件詳細項目の順に、本APIで作ります。式の案件詳細項目は、参照先を作った後に参照の順に作ります
  4. 手順3の各案件詳細項目は、次のように指定します
    • グループに入っている案件詳細項目は、dealCustomItemGroupId に、手順2で作ったグループの登録のレスポンスの id を指定します
    • before には、複製元の並び(同じグループの中、またはグループの外)でその案件詳細項目より後ろにある要素のうち、複製先に作成済みで最も前にあるものを指定します。グループの外の案件詳細項目は、手順2で作ったグループ({"dealCustomItemGroupId": グループの登録のレスポンスの id})も指定できます。先に作った案件詳細項目は {"dealCustomItemId": 本APIのレスポンスの id} で指定します。後ろに作成済みの要素が無いときは before を省略します(入れる先の末尾に入ります)
    • 式の参照先の案件詳細項目(model が deal_custom_item の modelId)は、先に作った参照先の本APIのレスポンスの id に置き換えます
  5. 選択肢の value は複製元の値をそのまま送ります。ID(dealCustomItemGroupId・before の中のID・案件詳細項目を参照する modelId)は案件タイプ・環境ごとに異なるため、必ず複製先で作った要素の id に置き換えます
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters

案件詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存

itemType
required
string
Enum: "text" "date" "number" "single_select" "multi_select" "decimal_number" "arithmetic" "url" "logical_formula" "user" "label"

案件詳細項目タイプ。以下のいずれかを指定します。

  • text: テキスト
  • url: URL
  • date: 日付
  • number: 数値
  • decimal_number: 数値(小数点あり)
  • single_select: 単一選択(表示形式は uiMode)
  • multi_select: 複数選択(表示形式は uiMode)
  • arithmetic: 四則演算
  • logical_formula: 数式
  • user: ユーザー
  • label: ラベル
itemKey
string or null <= 100 characters

API項目キー。100文字以内。案件タイプ内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす

uiMode
integer or null
Enum: 1 2 3 4 null

表示形式。itemType が single_select・multi_select・label のときだけ使います。省略・null のときは画面で作成したときと同じ値

  • single_select: 1(プルダウン)か 2(ラジオボタン)。省略時は 2
  • multi_select: 1(プルダウン)か 3(チェックボックス)。省略時は 3
  • label: 4(ラベル)のみ。省略時は 4
  • 上記以外の itemType: 指定しても null
description
string or null <= 200 characters

説明。200文字以内・改行不可

dealCustomItemGroupId
integer or null

所属する案件詳細項目グループID。同じ案件タイプのグループだけ指定できます。省略・null のときはグループに入れません

object or null = 1 properties

並び位置。省略・null のときは入れる先(グループ内・グループ外)の末尾

Array of objects or null (DealCustomItemCreateOption)

案件詳細選択項目リスト。itemType が single_select・multi_select のときだけ指定し、配列の順が並び順になります。itemType が label のときは空配列か省略(ラベルは、案件の登録・更新でラベル名を指定したときに作られます)

Array of objects or null (DealCustomItemFormulaPartRequest)

数式の定義。itemType が logical_formula のときは必須。参照先と参照先の間には演算子が必要です。商品内訳・請求サイトは、関数の範囲(funcStart の部品から funcEnd の部品まで)の内側にだけ置けます

Array of objects or null (DealCustomItemFormulaPartRequest)

四則演算の定義。itemType が arithmetic のときは必須。参照先・演算子・参照先の3部品。参照先は契約金額か数値・数値(小数点あり)の案件詳細項目

Responses

Request samples

Content type
application/json
Example
{
  • "name": "予算メモ",
  • "itemType": "text",
  • "itemKey": "budget_memo",
  • "description": "予算の補足を書きます"
}

Response samples

Content type
application/json
{
  • "id": 203,
  • "itemKey": "lead_source",
  • "name": "流入経路",
  • "itemType": "single_select",
  • "uiMode": 2,
  • "description": null,
  • "dealCustomItemGroupId": null,
  • "customItemOptions": [
    ],
  • "logicalFormula": null,
  • "dealCustomItemCalculations": null
}

案件詳細項目設定情報更新

案件詳細項目を1件更新します。指定した項目だけを変更し、省略した項目は変更しません。

  • 案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で取得した案件詳細項目1件を、そのまま送れます。そのまま送ったときは何も変わりません。リクエストのスキーマに無いキーは、送っても無視します
  • 案件詳細項目タイプ(itemType)と既存の選択肢の値(value)は変更できません。現在と同じ値は受け付け、違う値は400になります。案件詳細項目タイプを変えるときは、新しい案件詳細項目を作ってから古い案件詳細項目を削除します
  • 選択肢(customItemOptions)は差分で指定します。id を指定した選択肢は更新、id が無い選択肢は追加、id と deleted: true を指定した選択肢は削除します。送らなかった選択肢は変わりません。id の無い選択肢は再送のたびに追加されます
  • 送らなかった選択肢は並び順の値を保ち、送った選択肢(削除を除く)は、空いている並び順に配列の順で先頭から入ります。たとえば選択肢が A・B・C・D の順のとき、C・A の順で送ると C・B・A・D になります。選択肢を削除した後は、この例と違う並びになることがあります。確実に並べるときは、全選択肢を新しい順で送ります
  • 選択肢の削除は取り消せません。削除した選択肢を選んでいた案件の値は消えます。Webフォーム(非公開を含み、削除したものを除く)で使われている案件詳細項目の選択肢は削除できず、messages に使用先のWebフォーム名が入ります
  • ラベル型(itemType が label)のラベルは、追加・名前の変更・削除・並べ替えができません。ラベルは、案件の登録・更新でラベル名を指定したときに作られます
  • 並び位置(before)を指定するとその要素の前に移り、後ろの要素は順にずれます。null を指定すると移動先の末尾に移ります。省略すると位置は変わりません
  • 所属する案件詳細項目グループ(dealCustomItemGroupId)を変えて before を省略すると、移動先の末尾に入ります。null を指定するとグループから出ます
  • 数式(logicalFormula)・四則演算(dealCustomItemCalculations)は、送ると式全体が置き換わります。参照できる範囲と書き方は登録と同じです
  • ドメインの設定で利用していない案件詳細項目タイプ(数式・ユーザー・ラベル)の案件詳細項目は、値を変えると403になります
  • PAT の場合、管理者設定の権限と、対象の案件タイプの編集権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も変更されません。入力エラーの messages には、<場所>: <理由> の形で最初の1件だけが入ります(例: itemType: 変更できません(現在の値: single_select))。場所の添字は0始まりで、送った配列の位置です
  • レスポンスは案件詳細項目設定情報の案件詳細項目(dealCustomItem)と同じ形です
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

id
required
integer

案件詳細項目ID

Request Body schema: application/json
required
name
string [ 1 .. 100 ] characters

案件詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存

itemType
string
Enum: "text" "date" "number" "single_select" "multi_select" "decimal_number" "arithmetic" "url" "logical_formula" "user" "label"

案件詳細項目タイプ。変更不可(現在の値だけ指定できます)

itemKey
string or null <= 100 characters

API項目キー。100文字以内。案件タイプ内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。null・空文字・空白だけのときは API項目キーを消す

uiMode
integer or null
Enum: 1 2 3 4 null

表示形式。itemType が single_select・multi_select のときだけ変更できます。null には変更できません

  • single_select: 1(プルダウン)か 2(ラジオボタン)
  • multi_select: 1(プルダウン)か 3(チェックボックス)
  • label: 4(ラベル)のみ
  • 上記以外の itemType: 指定しても変更しない
description
string or null <= 200 characters

説明。200文字以内・改行不可。null のときは説明を消す

dealCustomItemGroupId
integer or null

所属する案件詳細項目グループID。同じ案件タイプのグループだけ指定できます。null のときはグループから出します。変更して before を省略したときは移動先の末尾に入ります

object or null = 1 properties

並び位置。省略したときは位置を変えません。null のときは移動先(グループ内・グループ外)の末尾。この案件詳細項目自身は指定できません

Array of objects or null (DealCustomItemUpdateOption)

案件詳細選択項目リスト(差分)。itemType が single_select・multi_select のときだけ指定できます。送らなかった選択肢は変更しません。省略・null・空配列のときは変更しません。送った選択肢(削除を除く)は配列の順に並び、送らなかった選択肢は位置を保ちます。itemType が label のときは取得したままの選択肢だけ指定できます(ラベルは追加・変更・削除・並べ替えができません)

Array of objects or null (DealCustomItemFormulaPartRequest)

数式の定義。itemType が logical_formula のときだけ指定でき、指定すると式全体を置き換えます。省略・空配列のときは変更しません。null は指定できません。参照できる範囲は登録と同じです

Array of objects or null (DealCustomItemFormulaPartRequest)

四則演算の定義。itemType が arithmetic のときだけ指定でき、指定すると式全体を置き換えます。省略・空配列のときは変更しません。null は指定できません。参照先・演算子・参照先の3部品

Responses

Request samples

Content type
application/json
Example
{
  • "name": "流入経路(改)",
  • "customItemOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemKey": "string",
  • "name": "string",
  • "itemType": "text",
  • "uiMode": 0,
  • "description": "string",
  • "dealCustomItemGroupId": 0,
  • "customItemOptions": [
    ],
  • "logicalFormula": [
    ],
  • "dealCustomItemCalculations": [
    ]
}

案件詳細項目設定情報削除

案件詳細項目を1件削除します。削除は取り消せません。

  • 画面から削除したときと同じく、全案件の入力済みの値、フェーズ別必須入力項目の設定、選択肢・ラベル、四則演算の定義も削除されます
  • 次の場合は削除できず400になり、何も削除されません。messages に使用先が入ります(複数に当たるときは四則演算・数式からの参照を返します)
    • 四則演算・数式から参照されている: 先に参照元の式を案件詳細項目設定情報更新(PATCH /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items/{id})で差し替えるか、参照元の案件詳細項目を削除します。数式からの参照は、ドメインの設定で数式を利用しているときだけ判定します
    • Webフォーム(非公開を含み、削除したものを除く)で使われている: Webフォーム側で外します。Webフォームを利用していないドメインでは判定しません
  • 数式・Webフォームを利用していない間に削除すると、参照元の数式・Webフォームは、削除した案件詳細項目を指したままになります。利用を再開したら、参照元を直してください
  • オートメーション・レポート・検索条件などからの参照は判定しません。削除するとそれらの設定が動かなくなることがあります
  • 残る案件詳細項目・案件詳細項目グループの並び順は変わりません
  • 選択肢の削除は案件詳細項目設定情報更新(PATCH /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items/{id})で行います
  • ドメインの設定で利用していない案件詳細項目タイプ(数式・ユーザー・ラベル)の案件詳細項目は削除できず403になります
  • 削除済みの案件詳細項目を指定すると404になります
  • PAT の場合、管理者設定の権限と、対象の案件タイプの参照権限・編集権限が必要です(TAT では権限を判定しません)
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

id
required
integer

案件詳細項目ID

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "messages": [
    ]
}

案件詳細項目グループ設定情報登録

案件タイプに、案件詳細項目の入っていない案件詳細項目グループを1件登録します。

  • 案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で取得した案件詳細項目グループ(layout の dealCustomItemGroup)1件を、そのまま送れます。リクエストのスキーマに無いキー(id・dealCustomItems など)は、送っても無視します
  • 登録できるのは名前と並び位置です。案件詳細項目をグループに入れるときは、案件詳細項目設定情報登録(POST /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)・案件詳細項目設定情報更新(PATCH /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items/{id})で所属する案件詳細項目グループID(dealCustomItemGroupId)に、返された id を指定します
  • 並び位置(before)を指定するとその要素の前に入り、後ろの要素は順にずれます。指定できるのは、グループに入っていない案件詳細項目と案件詳細項目グループです。before に指定する ID は案件詳細項目設定情報で取得します
  • 並び位置(before)を省略すると先頭に入り、他の要素は順を保って後ろにずれます。末尾を指定して登録することはできません。before に null は指定できません
  • 別の案件タイプ・環境へ同じ並びで複製する手順は、案件詳細項目設定情報登録(POST /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)の説明を参照してください
  • ドメインの設定で利用していない案件詳細項目タイプ(数式・ユーザー・ラベル)の案件詳細項目は、before に指定できません
  • PAT の場合、管理者設定の権限と、対象の案件タイプの編集権限が必要です(TAT では権限を判定しません)
  • エラーがあれば何も登録されません。入力エラーの messages には、<場所>: <理由> の形で最初の1件だけが入ります(例: before.dealCustomItemId: 対象の案件タイプに存在しないIDです)
  • 同じ内容を再送すると、同じ名前の案件詳細項目グループがもう1件作られます
  • レスポンスは案件詳細項目設定情報の案件詳細項目グループ(dealCustomItemGroup)と同じ形です。登録直後の dealCustomItems は空です
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters

案件詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。同じ名前のグループも登録できます

object = 1 properties

並び位置。グループに入っていない案件詳細項目か案件詳細項目グループの前に入り、後ろの要素は順にずれます。省略したときは先頭。null は指定できません

Responses

Request samples

Content type
application/json
{
  • "name": "契約情報",
  • "before": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "dealCustomItems": [
    ]
}

案件詳細項目グループ設定情報更新

案件タイプの案件詳細項目グループ1件の名前と並び位置を更新します。

  • 指定した項目だけを更新し、省略した項目は変更しません
  • 案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で取得した案件詳細項目グループ(layout の dealCustomItemGroup)1件を、そのまま送れます。リクエストのスキーマに無いキー(id・dealCustomItems など)は、送っても無視します
  • 更新できるのは名前と並び位置です。グループに入っている案件詳細項目の出し入れは本APIでは行えません。新しく作る案件詳細項目をグループに入れるときは、案件詳細項目設定情報登録(POST /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で所属する案件詳細項目グループID(dealCustomItemGroupId)を指定します
  • 並び位置(before)を指定すると、グループは中の案件詳細項目ごとその要素の前に移り、他の要素は順を保ってずれます。グループの中の案件詳細項目の並びは変わりません。指定できるのは、グループに入っていない案件詳細項目と、他の案件詳細項目グループです。before に指定する ID は案件詳細項目設定情報で取得します
  • before に null を指定すると末尾に移ります。登録したグループを末尾に置くときも、本APIで before に null を指定します。before を省略すると並び位置は変わりません
  • ドメインの設定で利用していない案件詳細項目タイプ(数式・ユーザー・ラベル)の案件詳細項目は、before に指定できません
  • 名前は変更するときだけ、前後の空白を除いて1〜100文字かを確認します。今と同じ名前はそのまま送れます
  • PAT の場合、管理者設定の権限と、対象の案件タイプの編集権限が必要です(TAT では権限を判定しません)
  • エラーがあれば何も更新されません。入力エラーの messages には、<場所>: <理由> の形で最初の1件だけが入ります(例: before.dealCustomItemId: 対象の案件タイプに存在しないIDです)
  • レスポンスは案件詳細項目設定情報の案件詳細項目グループ(dealCustomItemGroup)と同じ形です
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

id
required
integer

案件詳細項目グループID

Request Body schema: application/json
required
name
string [ 1 .. 100 ] characters

案件詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。null は指定できません

object or null = 1 properties

並び位置。グループに入っていない案件詳細項目か他の案件詳細項目グループの前に、中の案件詳細項目ごと移り、他の要素は順にずれます。null のときは末尾。省略したときは変更しません

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "before": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "dealCustomItems": [
    ]
}

案件詳細項目グループ設定情報削除

案件タイプの案件詳細項目グループ1件を削除します。

  • 削除したグループは元に戻せません
  • 中に案件詳細項目が残っていても削除できます。中の案件詳細項目は削除されず、グループに入っていない案件詳細項目になり、入力済みの値も残ります
  • 中の案件詳細項目は、グループ内の並び順のまま、グループに入っていない案件詳細項目としてまとめて並びます。並ぶ位置は、削除したグループより後ろにあるグループ外の案件詳細項目のうち、最後のものの直後です。後ろにグループ外の案件詳細項目が無ければ、削除したグループの位置に並びます
    • 例: a、[G1: x y]、b、c、[G2: z] から G1 を削除すると、a、b、c、x、y、[G2: z]
    • 例: a、[G1: x y]、[G2: z] から G1 を削除すると、a、x、y、[G2: z]
  • 他の案件詳細項目と案件詳細項目グループの並び順は変わりません
  • 別のグループへ移したい案件詳細項目は、削除の前に移します
  • ドメインの設定で利用していない案件詳細項目タイプ(数式・ユーザー・ラベル)の案件詳細項目は、グループに入っていない案件詳細項目になるだけで、並び位置は変わりません
  • 案件詳細項目グループIDと中の案件詳細項目は、案件詳細項目設定情報(GET /v2/deal_setting/deal_types/{deal_type_id}/deal_custom_items)で取得します
  • PAT の場合、管理者設定の権限と、対象の案件タイプの編集権限が必要です(TAT では権限を判定しません)
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

id
required
integer

案件詳細項目グループID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

商品内訳設定(DealProductDetailTypes)

商品内訳設定リスト

商品内訳設定の一覧を取得します。

  • レスポンスは v1同様の dealProductDetailTypes キー({ totalCount, page, dealProductDetailTypes })
  • v1同様の page / limit によるページ方式(limit のデフォルトは100、最大1000)
  • dealProductDetailTypeCustom は詳細項目の itemKey(API項目キー)をプロパティ名にしたオブジェクトで、型に該当する値フィールドのみを返します
  • PAT は商品内訳設定の権限が必要です(TAT は権限チェックの対象外)
  • 閲覧権限による絞り込みはなく、ドメイン内の全件が対象です
Authorizations:
bearer_auth
query Parameters
page
integer >= 1
Default: 1

ページ番号(1始まり)。未指定時は1ページ目

limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)。0以下の場合は100、1000を超える場合は1000として扱います

sort
string

並び順。キーの前に - を付けると降順。カンマ区切りで複数指定可 ソート可能 name、orderNum、price、createdAt、updatedAt、unitCost、grossProfitMargin(snake_case でも指定可) 省略時は id の昇順。指定した場合も末尾に id の昇順が付与されます。指定できないキーは無視されます

dealTypeId
Array of integers

案件タイプID。未指定時はドメイン全ての商品内訳設定を取得します。指定時は指定案件タイプで利用可能な商品内訳設定を取得します。dealTypeId[]=1&dealTypeId[]=2 のような形式で指定することで複数にも対応できます

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "dealProductDetailTypes": [
    ]
}

商品内訳設定カスタム項目リスト

商品内訳設定のカスタム項目(詳細項目)定義の一覧を取得します。

  • v1同様ページングはなく、ドメイン内の全件を orderNum、id の昇順で返します
  • レスポンスのルートキーは dealProductDetailTypeCustomItems(v2のレスポンスキーはすべて camelCase)
  • 選択肢(dealProductDetailTypeCustomItemOptions)は itemType が single_select / multi_select の項目のみ返します
  • PAT は商品内訳設定の権限が必要です(TAT は権限チェックの対象外)
  • 閲覧権限による絞り込みはなく、ドメイン内の全件が対象です
Authorizations:
bearer_auth
query Parameters
dealTypeId
Array of integers

案件タイプID。未指定時はドメイン全ての商品内訳設定カスタム項目を取得します。指定時は指定案件タイプで利用可能な商品内訳設定カスタム項目を取得します。dealTypeId[]=1&dealTypeId[]=2 のような形式で指定することで複数にも対応できます

Responses

Response samples

Content type
application/json
{
  • "dealProductDetailTypeCustomItems": [
    ]
}

商品内訳設定一括登録

商品内訳設定を一括登録します(同期実行)。

  • 成功時は作成した商品内訳設定IDの配列を返します
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • カスタム項目の値は value で渡し、項目タイプに応じた属性へ自動的に振り分けられます
  • このAPIを使って登録した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (DealProductDetailTypeBulkCreateItem) <= 1000 items

登録する商品内訳設定の配列

Responses

Request samples

Content type
application/json
{
  • "dealProductDetailTypes": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

商品内訳設定一括更新

商品内訳設定を一括更新します(同期実行)。

  • 成功時はレスポンスボディを返しません(200のみ)
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • 指定したキーのみ更新されます
  • 案件で使用中、または数式項目から参照中の案件タイプの紐付けは解除できません
  • このAPIを使って更新した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (DealProductDetailTypeBulkUpdateItem) <= 1000 items

更新する商品内訳設定の配列

Responses

Request samples

Content type
application/json
{
  • "dealProductDetailTypes": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "error": "Bad Request",
  • "messages": [
    ]
}

案件(Deals)

案件情報リスト

案件一覧をカーソルページネーション形式で取得します

  • レスポンスは v1 と同じ deals キーの配列を含む構造 ({ deals, hasMore, nextCursor, totalCount })
  • 10,000 件超のデータでもカーソル経由で順次取得可能
Authorizations:
bearer_auth
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

searchWord
string

指定した文字列と取引先名、または案件名が部分一致する案件を検索します。

dealTypeId
integer

案件タイプID

sort
string

並び順。- プレフィックスで降順。省略時は更新日時の降順。 ソート可能 updatedAt、createdAt

updatedAtFrom
string <date-time>
Example: updatedAtFrom=2018-04-01T10:30:00+09:00

更新日時による検索範囲(開始)。タイムゾーンを明示すること(省略時はUTCとして解釈される)

updatedAtTo
string <date-time>
Example: updatedAtTo=2018-04-01T10:30:00+09:00

更新日時による検索範囲指定(終了)。タイムゾーンを明示すること(省略時はUTCとして解釈される)

itemKeyAsPropertyKey
string
Enum: "true" "false"

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

Responses

Response samples

Content type
application/json
{
  • "deals": [
    ],
  • "hasMore": true,
  • "nextCursor": "string",
  • "totalCount": 0
}

案件情報登録

案件を登録します。

  • 関連リソース(customer / dealType / phase / product / probability / channel / user)は { "id": N } 形式で指定
  • 関連リソースIDが存在しない/別ドメインの場合は 404
  • 入力値の型不正は 400 Bad Request、バリデーション失敗は 400 Validation Failed
Authorizations:
bearer_auth
query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
itemKeyAsPropertyKey
string
Enum: "true" "false"

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

Request Body schema: application/json
required
name
required
string

案件名

amount
integer or null

契約金額

expectedContractDate
required
string <date>

契約予定日。YYYY-MM-DD

reason
string or null

最終停止理由。フェーズが進行中以外のときに endPhaseReasonIds とどちらか必須

required
object

取引先

required
object

案件タイプ

required
object

フェーズ

required
object

商品

required
object

契約確度

required
object

チャネル

required
object

ユーザー

endPhaseReasonIds
Array of integers

最終停止理由ID 配列。フェーズが進行中以外のときに reason とどちらか必須

Array of objects (DealCustomCreateParam)

案件詳細項目の登録値の配列。項目は dealCustomItemId か itemKey で特定する

Array of objects (DealProductDetailCreateParam)

商品内訳の配列

Array of objects (DealCustomerCreateParam)

関連取引先の配列

Array of objects (CustomObjectAssociationParam)

関連付けカスタムオブジェクト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "amount": 0,
  • "expectedContractDate": "2019-08-24",
  • "reason": "string",
  • "customer": {
    },
  • "dealType": {
    },
  • "phase": {
    },
  • "product": {
    },
  • "probability": {
    },
  • "channel": {
    },
  • "user": {
    },
  • "endPhaseReasonIds": [
    ],
  • "dealCustoms": [
    ],
  • "dealProductDetails": [
    ],
  • "dealCustomers": [
    ],
  • "customObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "amount": 0,
  • "expectedAmount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2019-08-24",
  • "reason": "string",
  • "totalCost": "string",
  • "totalProfit": "string",
  • "dealType": {
    },
  • "customer": {
    },
  • "phase": {
    },
  • "product": {
    },
  • "probability": {
    },
  • "channel": {
    },
  • "user": {
    },
  • "endPhaseReasons": [
    ],
  • "phaseStayDays": [
    ],
  • "currentPhaseStayDays": 0,
  • "dealProductDetails": [
    ],
  • "dealCustomerTypes": [
    ],
  • "dealCustoms": [
    ],
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00"
}

案件情報検索

案件情報を検索します。

  • レスポンスはカーソルページネーション形式 ({ deals, hasMore, nextCursor, totalCount })
  • filter / sort に指定できる標準項目は、各スキーマの説明に記載のものに限られます(それ以外は 400 になります)
  • 並び順は request body の sort で指定できます(例: name / updated_at / created_at)。省略時は updated_at 降順(id 昇順タイブレーク)
Authorizations:
bearer_auth
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

Request Body schema: application/json
required
required
object (DealSearchFilter)

絞り込み条件

  • compositeFilter と valueFilter を合わせて最大300個まで指定できます(最上位の compositeFilter は件数に含まれません)。
object (DealSearchSort)

並び替え条件。省略時は updated_at 降順(id 昇順タイブレーク)。 項目値が未設定のものは、昇順では先頭・降順では末尾に並びます。

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": {
    }
}

Response samples

Content type
application/json
{
  • "deals": [
    ],
  • "hasMore": true,
  • "nextCursor": "string",
  • "totalCount": 0
}

案件情報

案件詳細を取得します。

  • include_related_objects=1 を指定すると関連カスタムオブジェクト情報(customObjects)を含みます
Authorizations:
bearer_auth
path Parameters
id
required
integer

案件ID

query Parameters
itemKeyAsPropertyKey
string
Enum: "true" "false"

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

include_related_objects
integer
Default: 0

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "amount": 0,
  • "expectedAmount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2019-08-24",
  • "reason": "string",
  • "totalCost": "string",
  • "totalProfit": "string",
  • "dealType": {
    },
  • "customer": {
    },
  • "phase": {
    },
  • "product": {
    },
  • "probability": {
    },
  • "channel": {
    },
  • "user": {
    },
  • "endPhaseReasons": [
    ],
  • "phaseStayDays": [
    ],
  • "currentPhaseStayDays": 0,
  • "dealProductDetails": [
    ],
  • "dealCustomerTypes": [
    ],
  • "dealCustoms": [
    ],
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00"
}

案件情報更新

案件を部分更新(PATCH)します。

  • リクエストに含めたキーのみ更新する(部分更新)
  • 関連リソース(customer / phase / product / probability / channel / user)は { "id": N } 形式で指定
  • 対象案件 / 関連リソースIDが存在しない・別ドメインの場合は 404 NOT_FOUND
  • 入力値の型不正は 400 BAD_REQUEST、バリデーション失敗は 400 VALIDATION_FAILED
Authorizations:
bearer_auth
path Parameters
id
required
integer

案件ID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
itemKeyAsPropertyKey
string
Enum: "true" "false"

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

Request Body schema: application/json
required
name
string

案件名

amount
integer or null

契約金額

expectedContractDate
string <date>

契約予定日。YYYY-MM-DD

reason
string or null

最終停止理由。フェーズが進行中以外のときに endPhaseReasonIds とどちらか必須

object

取引先

object

フェーズ

object

商品

object

契約確度

object

チャネル

object

ユーザー

endPhaseReasonIds
Array of integers

最終停止理由ID 配列。フェーズが進行中以外のときに reason とどちらか必須

Array of objects (DealCustomUpdateParam)

案件詳細項目の更新値の配列。項目は id / dealCustomItemId / itemKey で特定する。value に空値(null / 空文字 / 空配列)を指定すると値を削除する(value を含めない要素は変更しない)。ただし label タイプは、null を指定しても変更されず、空配列で削除されます

Array of objects (DealProductDetailUpdateParam)

商品内訳。id 指定で更新、deleted で削除、id なしで追加

Array of objects (DealCustomerUpdateParam)

関連取引先。delete で解除

Array of objects (CustomObjectAssociationParam)

関連付けカスタムオブジェクト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "amount": 0,
  • "expectedContractDate": "2019-08-24",
  • "reason": "string",
  • "customer": {
    },
  • "phase": {
    },
  • "product": {
    },
  • "probability": {
    },
  • "channel": {
    },
  • "user": {
    },
  • "endPhaseReasonIds": [
    ],
  • "dealCustoms": [
    ],
  • "dealProductDetails": [
    ],
  • "dealCustomers": [
    ],
  • "customObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "amount": 0,
  • "expectedAmount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2019-08-24",
  • "reason": "string",
  • "totalCost": "string",
  • "totalProfit": "string",
  • "dealType": {
    },
  • "customer": {
    },
  • "phase": {
    },
  • "product": {
    },
  • "probability": {
    },
  • "channel": {
    },
  • "user": {
    },
  • "endPhaseReasons": [
    ],
  • "phaseStayDays": [
    ],
  • "currentPhaseStayDays": 0,
  • "dealProductDetails": [
    ],
  • "dealCustomerTypes": [
    ],
  • "dealCustoms": [
    ],
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00"
}

案件情報削除

指定した案件を削除します。

  • 成功時はレスポンスボディなしで 200 を返す(v1同様。204は返さない)
Authorizations:
bearer_auth
path Parameters
id
required
integer

案件ID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

案件一括登録

案件を一括登録します(v1同様の同期実行)。

  • 案件タイプはパスパラメータ dealTypeId で指定します
  • 成功時は作成した案件IDの配列を返します
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です。
Authorizations:
bearer_auth
path Parameters
dealTypeId
required
integer

案件タイプID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 本エンドポイント(一括登録/更新)はそもそも通知を送信しないため、指定しても効果はありません。
  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱いで、400にはなりません。
Request Body schema: application/json
required
required
Array of objects (DealBulkCreateItem)

登録する案件の配列(最大1000件)

Responses

Request samples

Content type
application/json
{
  • "deals": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

案件一括更新

案件を一括更新します(v1同様の同期実行)。

  • 案件タイプはパスパラメータ dealTypeId で指定します
  • 各案件は id で既存レコードを特定し、送信したフィールドのみ更新します(部分更新)
  • 成功時は更新した案件(deals)とスキップした案件(skippedDeals)を返します
  • 案件ロック中(受注・失注フェーズ)の案件のロック対象項目を更新しようとした場合、その案件はスキップされ skippedDeals に含まれます(PAT のみ対象・TAT はロック無視)
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です。
Authorizations:
bearer_auth
path Parameters
dealTypeId
required
integer

案件タイプID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 本エンドポイント(一括登録/更新)はそもそも通知を送信しないため、指定しても効果はありません。
  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱いで、400にはなりません。
Request Body schema: application/json
required
required
Array of objects (DealBulkUpdateItem)

更新する案件の配列(最大1000件)

Responses

Request samples

Content type
application/json
{
  • "deals": [
    ]
}

Response samples

Content type
application/json
{
  • "deals": [
    ],
  • "skippedDeals": [
    ]
}

案件コンタクト(DealsContacts)

案件コンタクトリスト

指定した案件に紐づくコンタクト一覧をv1同様のページ方式で取得します。

  • レスポンスは v1同様の contacts キー ({ contacts, totalCount, page })
Authorizations:
bearer_auth
path Parameters
deal_id
required
integer

案件ID

query Parameters
page
integer >= 1
Default: 1

ページ番号(1始まり)。未指定時は1ページ目

Responses

Response samples

Content type
application/json
{
  • "contacts": [
    ],
  • "totalCount": 0,
  • "page": 0
}

案件コンタクト情報登録

Authorizations:
bearer_auth
path Parameters
deal_id
required
integer

案件ID

contact_id
required
integer

コンタクトID

Responses

Response samples

Content type
application/json
{
  • "error": "Validation Failed",
  • "errors": {
    },
  • "messages": [
    ]
}

案件コンタクト情報削除

指定した案件からコンタクトの紐付けを削除します。

  • 成功時はレスポンスボディなしで 200 を返す(v1同様。204は返さない)
  • コンタクト自体は削除されず、案件との紐付けのみ削除される
Authorizations:
bearer_auth
path Parameters
deal_id
required
integer

案件ID

contact_id
required
integer

コンタクトID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

案件アクション(Actions)

案件アクション情報リスト

案件アクション一覧をカーソルページネーション形式で取得します。

  • レスポンスは v1 と同じ actions キーの配列を含む構造({ actions, hasMore, nextCursor, totalCount })
Authorizations:
bearer_auth
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

sort
string
Default: "-startDatetime"
Enum: "startDatetime" "-startDatetime" "start_datetime" "-start_datetime"

並び順 ソート可能 startDatetime (- プレフィックスで降順。デフォルトは -startDatetime)

startDatetime
string <date-time>

開始日時

endDatetime
string <date-time>

終了日時

createdAtFrom
string <date-time>

登録日時開始時間

createdAtTo
string <date-time>

登録日時終了時間

updatedAtFrom
string <date-time>

最終更新日時開始時間

updatedAtTo
string <date-time>

最終更新日時終了時間

users[][id]
Array of integers

担当者IDによる絞り込み(複数指定可)

purpose
integer

アクションの目的

active
string
Enum: "true" "false"

true:予定 false:完了

dealId
integer

案件IDを指定して検索します

Responses

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "hasMore": true,
  • "nextCursor": "string",
  • "totalCount": 0
}

案件アクション登録

案件アクションを新規登録します。

  • purpose、startDatetime、endDatetime、creator、deal は必須
Authorizations:
bearer_auth
query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
Request Body schema: application/json
required
object

アクションの目的

startDatetime
required
string <date-time>

開始日時

endDatetime
required
string <date-time>

終了日時

required
object

アクション担当者ID

required
object

案件ID

Array of objects

他の担当者

Array of objects

アクションコンタクト

Array of objects (ActionProposalInput) <= 30 items

同じ案件の提案。省略時は関連なし、空配列は関連なし

preNote
string or null

アクションの事前メモ

result
string or null

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

Array of objects

アクション詳細項目一覧

Responses

Request samples

Content type
application/json
{
  • "purpose": {
    },
  • "startDatetime": "2019-08-24T14:15:22Z",
  • "endDatetime": "2019-08-24T14:15:22Z",
  • "creator": {
    },
  • "deal": {
    },
  • "invitees": [
    ],
  • "contacts": [
    ],
  • "proposals": [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "actionCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "string",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "deal": {
    },
  • "purpose": {
    },
  • "contacts": [
    ],
  • "proposals": [
    ],
  • "actionCustoms": [
    ]
}

案件アクション情報

案件アクション詳細を取得します。

  • include_files=1 を指定するとファイル添付情報(files)を含みます
Authorizations:
bearer_auth
path Parameters
id
required
integer

アクションID

query Parameters
include_files
string
Default: "0"
Enum: "0" "1"

1 を指定すると、添付ファイルの情報を含めて返します。

Responses

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "id": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "deal": {
    },
  • "purpose": {
    },
  • "contacts": [
    ],
  • "proposals": [
    ],
  • "actionCustoms": [
    ]
}

案件アクション情報更新

案件アクションを更新します。

  • 指定したフィールドのみ更新します(部分更新)
  • invitees を指定した場合は全量置き換えになります
Authorizations:
bearer_auth
path Parameters
id
required
integer

アクションID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
Request Body schema: application/json
object

アクションの目的

startDatetime
string <date-time>

開始日時

endDatetime
string <date-time>

終了日時

object

アクション担当者ID

preNote
string or null

アクションの事前メモ

result
string or null

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

Array of objects

他の担当者

Array of objects

アクションコンタクト

Array of objects (ActionProposalInput) <= 30 items

同じ案件の提案。省略時は関連を維持、空配列はすべて解除

Array of objects

アクション詳細項目一覧

Responses

Request samples

Content type
application/json
{
  • "purpose": {
    },
  • "startDatetime": "2019-08-24T14:15:22Z",
  • "endDatetime": "2019-08-24T14:15:22Z",
  • "creator": {
    },
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "invitees": [
    ],
  • "contacts": [
    ],
  • "proposals": [
    ],
  • "actionCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "string",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "deal": {
    },
  • "purpose": {
    },
  • "contacts": [
    ],
  • "proposals": [
    ],
  • "actionCustoms": [
    ]
}

案件アクション情報削除

案件アクションを削除します。

  • 削除成功時はレスポンスボディなしで200を返す(v1同様。204は返さない)
Authorizations:
bearer_auth
path Parameters
id
required
integer

アクションID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

案件アクション一括登録

案件アクションを一括登録します(v1同様の同期実行)。

  • 成功時は作成したアクションIDの配列を返します
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です。
Authorizations:
bearer_auth
query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 本エンドポイント(一括登録/更新)はそもそも通知を送信しないため、指定しても効果はありません。
  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱いで、400にはなりません。
Request Body schema: application/json
dealTypeId
required
integer

案件タイプID

required
Array of objects

登録するアクションの配列

Responses

Request samples

Content type
application/json
{
  • "dealTypeId": 0,
  • "actions": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

提案設定(ProposalSettings)

提案タイプリスト

提案タイプの一覧を取得します。

  • ページングはありません(全件を配列で返します)
  • PATでは管理設定権限が必要です
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

提案タイプ設定情報

指定したIDの提案タイプ情報を取得します。

Authorizations:
bearer_auth
path Parameters
id
required
integer

提案タイプID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "dealTypes": [
    ],
  • "statuses": [
    ],
  • "acceptanceReasons": [
    ],
  • "rejectionReasons": [
    ],
  • "customItems": [
    ]
}

提案タイプ一括登録

提案タイプを一括登録します(同期実行)。

  • 成功時は登録後の提案タイプリストを返します
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • PATでは管理設定権限と一括設定権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalTypeCreateInput) [ 1 .. 1000 ] items

登録する提案タイプの配列

Responses

Request samples

Content type
application/json
{
  • "proposalTypes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

提案タイプ一括更新

提案タイプを一括更新します(同期実行)。

  • 各要素の id に更新対象の提案タイプIDを指定してください
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • 提案タイプの削除には対応していません
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalTypeUpdateInput) [ 1 .. 1000 ] items

更新する提案タイプの配列

Responses

Request samples

Content type
application/json
{
  • "proposalTypes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

提案ステータスリスト

提案ステータスの一覧を取得します。

  • ページングはありません(全件を配列で返します)
  • PATでは管理設定権限が必要です
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

提案ステータス情報

指定したIDの提案ステータス情報を取得します。

Authorizations:
bearer_auth
path Parameters
id
required
integer

提案ステータスID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "statusCategory": 0,
  • "bookingCategory": 0,
  • "description": "string"
}

提案ステータス一括登録

提案ステータスを一括登録します(同期実行)。

  • 成功時は登録後の提案ステータスリストを返します
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • PATでは管理設定権限と一括設定権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalStatusCreateInput) [ 1 .. 1000 ] items

登録する提案ステータスの配列

Responses

Request samples

Content type
application/json
{
  • "proposalStatuses": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

提案ステータス一括更新

提案ステータスを一括更新します(同期実行)。

  • 各要素の id に更新対象の提案ステータスIDを指定してください
  • ステータス分類と計上分類は変更できません
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • 提案ステータスの削除には対応していません
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalStatusUpdateInput) [ 1 .. 1000 ] items

更新する提案ステータスの配列

Responses

Request samples

Content type
application/json
{
  • "proposalStatuses": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

採択理由リスト

採択理由の一覧を取得します。

  • ページングはありません(全件を配列で返します)
  • PATでは管理設定権限が必要です
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

採択理由情報

指定したIDの採択理由情報を取得します。

Authorizations:
bearer_auth
path Parameters
id
required
integer

採択理由ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string"
}

採択理由一括登録

採択理由を一括登録します(同期実行)。

  • 成功時は登録後の採択理由リストを返します
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • PATでは管理設定権限と一括設定権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalReasonCreateInput) [ 1 .. 1000 ] items

登録する採択理由の配列

Responses

Request samples

Content type
application/json
{
  • "proposalAcceptanceReasons": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

採択理由一括更新

採択理由を一括更新します(同期実行)。

  • 各要素の id に更新対象の採択理由IDを指定してください
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • 採択理由の削除には対応していません
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalReasonUpdateInput) [ 1 .. 1000 ] items

更新する採択理由の配列

Responses

Request samples

Content type
application/json
{
  • "proposalAcceptanceReasons": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

不採択理由リスト

不採択理由の一覧を取得します。

  • ページングはありません(全件を配列で返します)
  • PATでは管理設定権限が必要です
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

不採択理由情報

指定したIDの不採択理由情報を取得します。

Authorizations:
bearer_auth
path Parameters
id
required
integer

不採択理由ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string"
}

不採択理由一括登録

不採択理由を一括登録します(同期実行)。

  • 成功時は登録後の不採択理由リストを返します
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • PATでは管理設定権限と一括設定権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalReasonCreateInput) [ 1 .. 1000 ] items

登録する不採択理由の配列

Responses

Request samples

Content type
application/json
{
  • "proposalRejectionReasons": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

不採択理由一括更新

不採択理由を一括更新します(同期実行)。

  • 各要素の id に更新対象の不採択理由IDを指定してください
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • 不採択理由の削除には対応していません
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalReasonUpdateInput) [ 1 .. 1000 ] items

更新する不採択理由の配列

Responses

Request samples

Content type
application/json
{
  • "proposalRejectionReasons": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

提案カスタム項目リスト

提案カスタム項目とグループの一覧を取得します。

  • ページングはありません(カスタム項目とグループをそれぞれ全件返します)
  • PATでは管理設定権限が必要です
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "proposalCustomItemGroups": [
    ],
  • "proposalCustomItems": [
    ]
}

提案カスタム項目情報

指定したIDの提案カスタム項目情報を取得します。

Authorizations:
bearer_auth
path Parameters
id
required
integer

提案カスタム項目ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "itemKey": "string",
  • "itemType": 0,
  • "uiMode": 0,
  • "orderNum": 0,
  • "groupOrderNum": 0,
  • "proposalCustomItemGroupId": 0,
  • "groupName": "string",
  • "customItemOptions": [
    ]
}

提案カスタム項目一括登録

提案カスタム項目とグループを一括登録します(同期実行)。

  • グループのみ、項目のみ、または両方を登録できます。少なくとも一方を1件指定してください
  • 1件でも失敗すると全件ロールバックされます
  • 項目・グループとも1リクエストあたりの上限は 1000 件です
  • PATでは管理設定権限と一括設定権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
Any of
required
Array of objects [ 1 .. 1000 ] items

登録するカスタム項目の配列

Array of objects (ProposalCustomItemGroupCreateInput) <= 1000 items

登録するグループの配列

Responses

Request samples

Content type
application/json
{
  • "proposalCustomItemGroups": [
    ],
  • "proposalCustomItems": [
    ]
}

Response samples

Content type
application/json
{
  • "proposalCustomItemGroups": [
    ],
  • "proposalCustomItems": [
    ]
}

提案カスタム項目一括更新

提案カスタム項目とグループを一括更新します(同期実行)。

  • 各要素の id に更新対象のIDを指定してください
  • 選択肢は追加・更新・削除できますが、項目とグループ自体は削除できません
  • 1件でも失敗すると全件ロールバックされます
  • 項目・グループとも1リクエストあたりの上限は 1000 件です
Authorizations:
bearer_auth
Request Body schema: application/json
required
Any of
required
Array of objects [ 1 .. 1000 ] items

更新するカスタム項目の配列

Array of objects (ProposalCustomItemGroupUpdateInput) <= 1000 items

更新するグループの配列

Responses

Request samples

Content type
application/json
{
  • "proposalCustomItemGroups": [
    ],
  • "proposalCustomItems": [
    ]
}

Response samples

Content type
application/json
{
  • "proposalCustomItemGroups": [
    ],
  • "proposalCustomItems": [
    ]
}

提案(Proposals)

提案情報登録

提案情報を登録します。

Authorizations:
bearer_auth
query Parameters
itemKeyAsPropertyKey
string
Enum: "true" "false"

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

Request Body schema: application/json
required
required
object (ProposalCreateInput)

登録する提案

Responses

Request samples

Content type
application/json
{
  • "proposal": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "dealId": 0,
  • "proposalType": {
    },
  • "proposalStatus": {
    },
  • "statusChangedAt": "2019-08-24T14:15:22Z",
  • "statusElapsedDays": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "actionCount": 0,
  • "latestCompletedActionAt": "2019-08-24T14:15:22Z",
  • "nextActionAt": "2019-08-24T14:15:22Z",
  • "reason": "string",
  • "proposalAcceptanceReasons": [
    ],
  • "proposalRejectionReasons": [
    ],
  • "proposalCustoms": [
    ],
  • "proposalProductDetails": [
    ]
}

提案情報検索

提案情報を検索し、カーソルページネーション形式で取得します。

  • filter で検索条件、sort で並び順を指定できます
  • 1回に取得できる件数は最大1000件です(デフォルト100件)
  • PATでは閲覧できる案件の提案のみ返します
Authorizations:
bearer_auth
Request Body schema: application/json
required
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string or null

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する

itemKeyAsPropertyKey
boolean
Default: false

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

object

検索条件。異なる条件間はANDで絞り込みます

object

並び替え条件。省略時は created_at 降順。同値の場合は id を同じ方向で並べ替えます。

Responses

Request samples

Content type
application/json
{
  • "limit": 100,
  • "cursor": "string",
  • "itemKeyAsPropertyKey": false,
  • "filter": {
    },
  • "sort": {
    }
}

Response samples

Content type
application/json
{
  • "proposals": [
    ],
  • "hasMore": true,
  • "totalCount": 0,
  • "nextCursor": "string"
}

提案情報

指定したIDの提案情報を取得します。

  • PATでは閲覧できる案件の提案のみ取得できます
  • 対象が存在しないか閲覧できない場合は404を返します
Authorizations:
bearer_auth
path Parameters
id
required
integer

提案ID

query Parameters
itemKeyAsPropertyKey
string
Enum: "true" "false"

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "dealId": 0,
  • "proposalType": {
    },
  • "proposalStatus": {
    },
  • "statusChangedAt": "2019-08-24T14:15:22Z",
  • "statusElapsedDays": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "actionCount": 0,
  • "latestCompletedActionAt": "2019-08-24T14:15:22Z",
  • "nextActionAt": "2019-08-24T14:15:22Z",
  • "reason": "string",
  • "proposalAcceptanceReasons": [
    ],
  • "proposalRejectionReasons": [
    ],
  • "proposalCustoms": [
    ],
  • "proposalProductDetails": [
    ]
}

提案情報更新

提案情報を更新します。

  • 指定したフィールドのみ更新します(部分更新)
Authorizations:
bearer_auth
path Parameters
id
required
integer

提案ID

query Parameters
itemKeyAsPropertyKey
string
Enum: "true" "false"

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります

Request Body schema: application/json
required
required
object (ProposalInput)

登録・更新する提案

Responses

Request samples

Content type
application/json
{
  • "proposal": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "dealId": 0,
  • "proposalType": {
    },
  • "proposalStatus": {
    },
  • "statusChangedAt": "2019-08-24T14:15:22Z",
  • "statusElapsedDays": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "actionCount": 0,
  • "latestCompletedActionAt": "2019-08-24T14:15:22Z",
  • "nextActionAt": "2019-08-24T14:15:22Z",
  • "reason": "string",
  • "proposalAcceptanceReasons": [
    ],
  • "proposalRejectionReasons": [
    ],
  • "proposalCustoms": [
    ],
  • "proposalProductDetails": [
    ]
}

提案情報削除

提案情報を削除します。

Authorizations:
bearer_auth
path Parameters
id
required
integer

提案ID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

提案一括登録

提案を一括登録します(同期実行)。

  • 成功時は作成した提案IDの配列を返します
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • PATでは一括処理権限と、親案件の編集権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalCreateInput) [ 1 .. 1000 ] items

登録する提案の配列

Responses

Request samples

Content type
application/json
{
  • "proposals": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

提案一括更新

提案を一括更新します(同期実行)。

  • 各要素の id に更新対象の提案IDを指定してください
  • 成功時は更新した提案IDの配列を返します
  • 1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です
  • PATでは一括処理権限と、親案件の編集権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
required
Array of objects (ProposalBulkUpdateInput) [ 1 .. 1000 ] items

更新する提案の配列

Responses

Request samples

Content type
application/json
{
  • "proposals": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

コンタクト設定(ContactSetting)

コンタクト設定

コンタクト詳細項目の定義の一覧と、案件のコンタクトタブに表示する項目を取得します。

  • ページングはありません。ドメイン内の全てのコンタクト詳細項目を orderNum、id の昇順で返します
  • ドメインの設定で無効になっているタイプ(user / label)の項目は返しません
  • コンタクト詳細項目は簡易な一覧です。コンタクト詳細項目グループ・画面の並び・表示形式・ラベル型のラベルの一覧はコンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)で取得してください
  • 取得結果を編集して、コンタクト設定更新(PATCH /v2/contact_setting)に送れます
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "contactCustomItems": [
    ],
  • "dealContactTabSettings": [
    ]
}

コンタクト設定更新

案件のコンタクトタブに表示する項目を更新します。

  • コンタクト設定(GET /v2/contact_setting)の結果を編集して送れます。リクエストに記載の無いキー(contactCustomItems など)は無視されます
  • 省略した設定は変わりません。案件のコンタクトタブに表示する項目(dealContactTabSettings)を省略すると何も変わりません
  • 案件のコンタクトタブに表示する項目は、送った一覧で置き換わります。必ず表示する5項目(name・email・company_name・department・position)を含め、最大10項目で、同じ項目を2回指定せずに送ります。守らない時は400です。ただし、保存済みの項目が10項目を超えている場合も、取得結果はそのまま送れます
  • 並び順は指定できません。配列の順は使われず、画面の表示順(基本項目は field の説明の順、続けてコンタクト詳細項目)で表示されます
  • 変更すると、全ユーザーの案件詳細のコンタクトタブの表示が変わります
  • コンタクト詳細項目は、取得結果の contactCustomItems[].id で指定します。別の環境の設定を移すときは、移行先の環境のコンタクト詳細項目IDに置き換えて送ります
  • 削除されたコンタクト詳細項目は指定できません。ライフサイクルステージをご契約でない場合の lifecycle_stage と、ドメインの設定で利用していないタイプのコンタクト詳細項目は、指定すると403になります
  • 取得結果をそのまま送ると、取得結果のとおりに保存されます。一度も設定していない場合は初期値の7項目で保存されます。取得結果に含まれない項目(ドメインの設定で使えない項目など)は保存から外れ、あとで使えるようにしても表示されません
  • コンタクト詳細項目・コンタクト詳細項目グループ・ライフサイクルステージ設定は更新されません
  • 同じ内容を再送しても結果は同じです
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: dealContactTabSettings[1].field)を文頭に付けて最初の1件を返します
  • レスポンスはコンタクト設定と同じ形です
  • リクエストの例は、必ず表示する5項目と phone、コンタクト詳細項目123を表示します
Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

案件のコンタクトタブに表示する項目。省略した場合は変更なし。送った一覧で置き換わる。必ず表示する5項目(name・email・company_name・department・position)を含め、最大10項目。配列の順は使われない

Responses

Request samples

Content type
application/json
{
  • "dealContactTabSettings": [
    ]
}

Response samples

Content type
application/json
{
  • "contactCustomItems": [
    ],
  • "dealContactTabSettings": [
    ]
}

コンタクト詳細項目設定情報

ドメインに設定されたコンタクト詳細項目とコンタクト詳細項目グループを、設定画面と同じ並びで取得します。

  • レスポンスはリソースオブジェクトを素で返します。ページングはありません
  • コンタクト設定(GET /v2/contact_setting)のコンタクト詳細項目(contactCustomItems)は簡易な一覧です。コンタクト詳細項目グループ・並び順・表示形式・ラベル型のラベルの一覧はこのAPIで取得してください
  • layout は画面の並び順に並び、グループに入っていないコンタクト詳細項目(contactCustomItem)とコンタクト詳細項目グループ(contactCustomItemGroup)が同じ並びを共有します。グループ内のコンタクト詳細項目は、グループの contactCustomItems にグループ内の並び順で並びます
  • 選択肢(customItemOptions)は itemType が single_select・multi_select の項目のみ値が設定されます
  • ユーザー型(itemType が user)の選択肢は返しません。ユーザーはユーザー情報リスト取得(GET /v2/users)で取得してください
  • ラベル(contactCustomItemLabels)は itemType が label の項目のみ値が設定されます。ラベルはコンタクトに付けたときに作られ、どのコンタクトにも付かなくなると消えます。ラベルには説明を設定できません
  • ドメインの設定で利用していない項目タイプ(ユーザー・ラベル)のコンタクト詳細項目は返しません
  • PAT の場合、権限設定を利用しているドメインではコンタクトの編集権限が無いと 403 になります
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "layout": [
    ]
}

コンタクト詳細項目設定情報登録

ドメインにコンタクト詳細項目を1件、選択肢と合わせて登録します。

  • コンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)で取得したコンタクト詳細項目1件を、そのまま送れます。リクエストに記載の無いキー(各要素の id・contactCustomItemLabels など)は無視されます
  • 並び位置(before)を指定するとその要素の前に入り、後ろの要素は順にずれます。省略するとグループ内・グループ外の末尾に入ります
  • single_select・multi_select は選択肢(customItemOptions)を1件以上送ります。選択肢の値(value)を省略すると、指定した値の最大値の次から配列の順に採番されます。移行・複製では複製元の値をそのまま送ります
  • 表示形式(uiMode)を省略すると、画面で作成した時と同じ表示形式(single_select はラジオボタン、multi_select はチェックボックス)になります。表示形式がラベル(4)の single_select・multi_select は登録できません
  • ラベル型(itemType が label)のコンタクト詳細項目は、ラベルを持たずに作られます。ラベルの一覧は移らず、ラベルはコンタクトにラベルを付けた時に作られます
  • ドメインの設定で利用していないコンタクト詳細項目タイプ(ユーザー・ラベル)のコンタクト詳細項目は登録できません。複製では飛ばし、必要ならドメインの設定で有効にしてから登録します
  • コンタクト詳細項目数・選択肢数がドメインの上限を超える時は400になり、messages に上限数が入ります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も登録されません。入力エラーの messages は、誤りのある場所(例: customItemOptions[1].label)を文頭に付けて最初の1件を返します
  • API項目キー(itemKey)の無い内容を再送すると、同じコンタクト詳細項目がもう1件作られます。itemKey を指定した再送は、同じAPI項目キーのコンタクト詳細項目があるため400になります
  • レスポンスはコンタクト詳細項目設定情報のコンタクト詳細項目(contactCustomItem)と同じ形です
  • リクエストの例の1つ目は、コンタクト詳細項目グループ10の中で、コンタクト詳細項目55の前に単一選択を作ります。value を省略した「高」「中」は、指定した値の最大値(9)の次から10・11になります。2つ目は、グループに入れずにコンタクト詳細項目グループ10の前にテキストを作ります

別の環境へ同じ並びで複製する手順は次のとおりです。複製先にコンタクト詳細項目・コンタクト詳細項目グループが無い場合に、複製元と同じ並びになります。

  1. 複製元でコンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)を呼び、layout を得ます
  2. layout の要素を後ろから順に作ります。グループに入っていないコンタクト詳細項目は本APIで、コンタクト詳細項目グループはコンタクト詳細項目グループ設定情報登録(POST /v2/contact_setting/contact_custom_item_groups)で作ります。最初の1つは before をキーごと省きます(コンタクト詳細項目グループの登録は before に null を送ると400です)。2つ目以降は直前に作った要素を before に指定します({"contactCustomItemId": 作ったコンタクト詳細項目の id} か {"contactCustomItemGroupId": 作ったグループの id})
  3. コンタクト詳細項目グループの中のコンタクト詳細項目を、グループ内の前から順に本APIで作ります。contactCustomItemGroupId に手順2で作ったグループの id を指定し、before は省略します(グループ内の末尾に入ります)
  4. 選択肢の value は複製元の値をそのまま送ります。ID(contactCustomItemGroupId と before の中のID)は環境ごとに異なるため、必ず複製先で作った要素の id に置き換えます
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string

コンタクト詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存

itemType
required
string

コンタクト詳細項目タイプ。以下のいずれか

  • text: テキスト
  • url: URL
  • date: 日付
  • number: 数値
  • decimal_number: 数値(小数点あり)
  • single_select: 単一選択(表示形式は uiMode でプルダウンかラジオボタンを指定)
  • multi_select: 複数選択(表示形式は uiMode でプルダウンかチェックボックスを指定)
  • user: ユーザー
  • label: ラベル
itemKey
string or null

API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。空文字・空白だけの時は未設定(null)

uiMode
integer or null

表示形式。itemType が single_select・multi_select の時のみ使用。省略・null の時は画面で作成した時と同じ値

  • single_select: 1(プルダウン)か 2(ラジオボタン)。省略時は 2
  • multi_select: 1(プルダウン)か 3(チェックボックス)。省略時は 3
  • 上記以外の itemType: 指定しても null
contactCustomItemGroupId
integer or null

所属するコンタクト詳細項目グループID。省略・null の時はグループに入れない

object or null

並び位置。省略・null の時は入れる先(グループ内・グループ外)の末尾

Array of objects or null (ContactCustomItemCreateOption)

コンタクト詳細選択項目リスト。itemType が single_select・multi_select の時は1件以上必須で、配列の順が並び順。それ以外の itemType では空か省略

Responses

Request samples

Content type
application/json
Example
{
  • "name": "確度",
  • "itemType": "single_select",
  • "itemKey": "probability_rank",
  • "uiMode": 1,
  • "contactCustomItemGroupId": 10,
  • "before": {
    },
  • "customItemOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemKey": "string",
  • "name": "string",
  • "itemType": "string",
  • "uiMode": 0,
  • "contactCustomItemGroupId": 0,
  • "customItemOptions": [
    ],
  • "contactCustomItemLabels": [
    ]
}

コンタクト詳細項目設定情報更新

コンタクト詳細項目1件を、送った項目だけ変更します。省略した項目は変更されません。

  • コンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)で取得したコンタクト詳細項目1件を、そのまま送れます。そのまま送った時は何も変わりません。リクエストに記載の無いキーは無視されます
  • コンタクト詳細項目タイプ(itemType)と既存の選択肢の値(value)は変更できません。現在と違う値を送ると400になります。型を変える時は、新しいコンタクト詳細項目を登録してから元のコンタクト詳細項目を削除します
  • 選択肢(customItemOptions)は差分で指定します。id のある選択肢は更新、id の無い選択肢は追加、id と deleted: true を指定した選択肢は削除されます。送らなかった選択肢は変わりません
  • 送った選択肢(削除を除く)は配列の順に並び、送らなかった選択肢は位置を保ちます。全体を並べ替える時は全選択肢を新しい順で送ります
  • 選択肢を削除すると、その選択肢を選んでいたコンタクトの値は消え、元に戻せません。アクションのCSV出力・API・キャンペーン・レポート・BI・オートメーション・名寄せなどで、そのコンタクト詳細項目を条件や表示に使っている場合も影響します
  • 最後の1件の選択肢は削除できません。削除されていない Webフォーム(非公開を含む)で使われているコンタクト詳細項目は、選択肢を削除できません
  • 表示形式がラベル(uiMode が 4)のコンタクト詳細項目は、表示形式と選択肢を変更できません。取得したままの選択肢のみ送れます
  • ラベル型(itemType が label)のラベル(contactCustomItemLabels)は、名前の変更・削除・追加ができません。取得したままのラベルのみ送れます。ラベルはコンタクトにラベルを付けた時に作られます
  • 並び位置(before)を指定するとその要素の前に移り、後ろの要素は順にずれます。before が null の時は移動先の末尾に移ります。省略した時は位置を変えません
  • グループへの出し入れは、所属するコンタクト詳細項目グループID(contactCustomItemGroupId)で行います。null の時はグループから出します。所属を変えて before を省略した時は、移動先の末尾に入ります
  • コンタクト詳細項目・選択肢・コンタクト詳細項目グループのIDは環境ごとに異なります。別の環境の内容に合わせる時は、コンタクト詳細項目設定情報で移行先のIDを調べて置き換えます。移行先に無い選択肢は id を付けずに送ると追加されます
  • id の無い選択肢を含む内容を再送すると、そのたびに選択肢が追加されます。id のある変更だけの内容は、再送しても同じ結果になります
  • ドメインの設定で利用していないコンタクト詳細項目タイプ(ユーザー・ラベル)のコンタクト詳細項目は、現在と違う値を送ると403になります
  • 選択肢数がドメインの上限を超える時は400になり、messages に上限数が入ります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も変更されません。入力エラーの messages は、誤りのある場所(例: customItemOptions[1].label)を文頭に付けて最初の1件を返します
  • レスポンスはコンタクト詳細項目設定情報のコンタクト詳細項目(contactCustomItem)と同じ形です
  • リクエストの例の1つ目は、選択肢301の名前を変え、「未定」を追加し、303を削除します。送らなかった選択肢(例: 302)は変わらず位置も保ち、301と「未定」はこの順で並びます。2つ目は、コンタクト詳細項目をグループから出して、グループ外の末尾に移します
Authorizations:
bearer_auth
path Parameters
id
required
integer

コンタクト詳細項目ID

Request Body schema: application/json
required
name
string

コンタクト詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存

itemType
string

コンタクト詳細項目タイプ。変更不可(現在の値のみ指定可能)

itemKey
string or null

API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。null・空文字・空白だけの時は API項目キーを消す

uiMode
integer or null

表示形式。itemType が single_select・multi_select の時のみ変更可能。null には変更不可

  • single_select: 1(プルダウン)か 2(ラジオボタン)
  • multi_select: 1(プルダウン)か 3(チェックボックス)
  • 表示形式が 4(ラベル)のコンタクト詳細項目: 変更不可(4 のみ指定可能)
  • 上記以外の itemType: 指定しても変更しない
contactCustomItemGroupId
integer or null

所属するコンタクト詳細項目グループID。null の時はグループから出す。変更して before を省略した時は移動先の末尾に入る

object or null

並び位置。省略した時は位置を変えない。null の時は移動先(グループ内・グループ外)の末尾。このコンタクト詳細項目自身は指定不可

Array of objects or null (ContactCustomItemUpdateOption)

コンタクト詳細選択項目リスト(差分)。itemType が single_select・multi_select の時のみ指定可能。送らなかった選択肢は変更しない。省略・null・空配列の時は変更しない。送った選択肢(削除を除く)は配列の順に並び、送らなかった選択肢は位置を保つ。表示形式が 4(ラベル)の時は取得したままの選択肢のみ指定可能(追加・変更・削除・並べ替え不可)

Array of objects or null (ContactCustomItemUpdateLabel)

コンタクト詳細項目ラベルリスト。itemType が label の時のみ指定可能で、取得したままのラベルのみ指定可能。省略・null・空配列の時は変更しない

Responses

Request samples

Content type
application/json
Example
{
  • "customItemOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemKey": "string",
  • "name": "string",
  • "itemType": "string",
  • "uiMode": 0,
  • "contactCustomItemGroupId": 0,
  • "customItemOptions": [
    ],
  • "contactCustomItemLabels": [
    ]
}

コンタクト詳細項目設定情報削除

コンタクト詳細項目を1件削除します。削除は取り消せません。

  • 画面から削除した時と同じく、全コンタクトの入力済みの値と、選択肢・ラベルも削除され、元に戻せません
  • コンタクト詳細項目は、アクションのCSV出力・API・キャンペーンの絞り込み・レポート・BI・オートメーション・名寄せからも参照されます。これらの参照は判定しないため、削除するとそれらの設定が動かなくなることがあります。コンタクトのレポートのこのコンタクト詳細項目の絞り込み条件は一緒に削除されます
  • 案件のコンタクトタブに表示していたコンタクト詳細項目は、表示から外れます
  • Webフォーム(非公開を含み、削除したものを除く)で使われているコンタクト詳細項目は削除できず400になり、何も削除されません。messages に使用先のWebフォーム名が入ります。Webフォーム側で外してから削除します。Webフォームを利用していないドメインでは判定しません
  • Webフォームを利用していない間に削除すると、利用を再開した時にWebフォームに削除したコンタクト詳細項目が残ります
  • 残るコンタクト詳細項目・コンタクト詳細項目グループの並び順は変わりません
  • 選択肢の削除はコンタクト詳細項目設定情報更新(PATCH /v2/contact_setting/contact_custom_items/{id})で行います。ラベル型のラベルは削除できず、コンタクトから外すと自動で削除されます
  • コンタクト詳細項目IDはコンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)で調べます
  • ドメインの設定で利用していないコンタクト詳細項目タイプ(ユーザー・ラベル)のコンタクト詳細項目は削除できず403になります
  • 削除済みのコンタクト詳細項目を指定すると404になります
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
Authorizations:
bearer_auth
path Parameters
id
required
integer

コンタクト詳細項目ID

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "messages": [
    ]
}

コンタクト詳細項目グループ設定情報登録

ドメインに、コンタクト詳細項目の入っていないコンタクト詳細項目グループを1件登録します。

  • コンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)で取得したコンタクト詳細項目グループ(layout の contactCustomItemGroup)1件を、そのまま送れます。リクエストに記載の無いキー(id・contactCustomItems など)は無視されます
  • 登録できるのは名前と並び位置です。コンタクト詳細項目をグループに入れる時は、コンタクト詳細項目設定情報登録(POST /v2/contact_setting/contact_custom_items)で所属するコンタクト詳細項目グループID(contactCustomItemGroupId)に、返された id を指定します
  • 並び位置(before)を指定するとその要素の前に入り、後ろの要素は順にずれます。指定できるのは、グループに入っていないコンタクト詳細項目とコンタクト詳細項目グループです。before に指定する ID はコンタクト詳細項目設定情報で取得します
  • 並び位置(before)を省略すると先頭に入り、他の要素は順を保って後ろにずれます。末尾を指定して登録することはできません。before に null は指定できません
  • 別の環境へ同じ並びで複製する手順は、コンタクト詳細項目設定情報登録(POST /v2/contact_setting/contact_custom_items)の説明を参照してください
  • ドメインの設定で利用していないコンタクト詳細項目タイプ(ユーザー・ラベル)のコンタクト詳細項目は、before に指定できません
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • エラーがあれば何も登録されません。入力エラーの messages は、誤りのある場所(例: before.contactCustomItemId)を文頭に付けて最初の1件を返します
  • 同じ内容を再送すると、同じ名前のコンタクト詳細項目グループがもう1件作られます。失敗したように見えた時は、再送の前にコンタクト詳細項目設定情報で作られていないか確かめます
  • レスポンスはコンタクト詳細項目設定情報のコンタクト詳細項目グループ(contactCustomItemGroup)と同じ形です。登録直後の contactCustomItems は空です
  • リクエストの例は、グループに入っていないコンタクト詳細項目55の前にコンタクト詳細項目グループを作ります
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string

コンタクト詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。同じ名前のグループも登録可能

object

並び位置。グループに入っていないコンタクト詳細項目かコンタクト詳細項目グループの前に入り、後ろの要素は順にずれる。省略時は先頭。null は指定不可

Responses

Request samples

Content type
application/json
{
  • "name": "商談情報",
  • "before": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "contactCustomItems": [
    ]
}

コンタクト詳細項目グループ設定情報更新

コンタクト詳細項目グループ1件の名前と並び位置を更新します。

  • 指定した項目だけを更新し、省略した項目は変更しません
  • コンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)で取得したコンタクト詳細項目グループ(layout の contactCustomItemGroup)1件を、そのまま送れます。リクエストに記載の無いキー(id・contactCustomItems など)は無視されます
  • 更新できるのは名前と並び位置です。グループに入っているコンタクト詳細項目の出し入れは本APIでは行えません。コンタクト詳細項目設定情報更新(PATCH /v2/contact_setting/contact_custom_items/{id})で、所属するコンタクト詳細項目グループID(contactCustomItemGroupId)を変更します
  • 並び位置(before)を指定すると、グループは中のコンタクト詳細項目ごとその要素の前に移り、他の要素は順を保ってずれます。グループの中のコンタクト詳細項目の並びは変わりません。指定できるのは、グループに入っていないコンタクト詳細項目と、他のコンタクト詳細項目グループです。before に指定する ID はコンタクト詳細項目設定情報で取得します
  • before に null を指定すると末尾に移ります。登録したグループを末尾に置く時も、本APIで before に null を指定します。before を省略すると並び位置は変わりません
  • ドメインの設定で利用していないコンタクト詳細項目タイプ(ユーザー・ラベル)のコンタクト詳細項目は、before に指定できません
  • 名前は変更する時だけ、前後の空白を除いて1〜100文字かを確認します。今と同じ名前はそのまま送れます
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • エラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: before.contactCustomItemId)を文頭に付けて最初の1件を返します
  • レスポンスはコンタクト詳細項目設定情報のコンタクト詳細項目グループ(contactCustomItemGroup)と同じ形です
  • リクエストの例は、コンタクト詳細項目グループを中のコンタクト詳細項目ごと末尾に移します
Authorizations:
bearer_auth
path Parameters
id
required
integer

コンタクト詳細項目グループID

Request Body schema: application/json
required
name
string

コンタクト詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。null は指定不可

object or null

並び位置。グループに入っていないコンタクト詳細項目か他のコンタクト詳細項目グループの前に、中のコンタクト詳細項目ごと移り、他の要素は順にずれる。null は末尾。省略時は変更しない

Responses

Request samples

Content type
application/json
{
  • "before": null
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "contactCustomItems": [
    ]
}

コンタクト詳細項目グループ設定情報削除

コンタクト詳細項目グループ1件を削除します。

  • 削除したグループは元に戻せません
  • 中にコンタクト詳細項目が残っていても削除できます。中のコンタクト詳細項目は削除されず、グループに入っていないコンタクト詳細項目になり、入力済みの値も残ります
  • 中のコンタクト詳細項目は、削除したグループより後ろにあるグループに入っていないコンタクト詳細項目の最後の直後に、グループ内の並び順のまままとめて並びます。後ろにグループに入っていないコンタクト詳細項目が無ければ、削除したグループの位置に並びます
  • 他のコンタクト詳細項目とコンタクト詳細項目グループの並び順は変わりません
  • 別のグループへ移したいコンタクト詳細項目は、削除の前にコンタクト詳細項目設定情報更新(PATCH /v2/contact_setting/contact_custom_items/{id})で移します
  • ドメインの設定で利用していないコンタクト詳細項目タイプ(ユーザー・ラベル)のコンタクト詳細項目は、グループに入っていないコンタクト詳細項目になるだけで、並び位置は変わりません
  • コンタクト詳細項目グループIDと中のコンタクト詳細項目は、コンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)で取得します
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
Authorizations:
bearer_auth
path Parameters
id
required
integer

コンタクト詳細項目グループID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

コンタクト(Contacts)

コンタクト情報リスト

コンタクト一覧をカーソルページネーション形式で取得します。

  • レスポンスは v1 同様に contacts キーの配列 ({ contacts, hasMore, nextCursor, totalCount })
  • v1 GET /api/v1/contacts と互換のあるフィルタを、v2 形式で提供します
Authorizations:
bearer_auth
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

searchWord
string

指定した文字列と取引先名、コンタクト名、またはメールアドレスが部分一致するコンタクトを検索します。

updatedAtFrom
string <date-time>
Example: updatedAtFrom=2018-04-01T10:30:00

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>
Example: updatedAtTo=2018-04-01T10:30:00

更新日時による検索範囲(終了)

  • ex) 2018-04-01T10:30:00
phoneNumber
string
Example: phoneNumber=03-1111-2222

固定電話番号、携帯電話番号による検索
ハイフン 市外局番 検索可能

  • ex) 03-1111-2222
  • ex) 0311112222
  • ex) 04992(0)1111
  • ex) 049920局1111
sort
string
Default: "-updated_at"
Enum: "updated_at" "-updated_at" "created_at" "-created_at" "updatedAt" "-updatedAt" "createdAt" "-createdAt"

並び順 ソート可能 updatedAt、createdAt (- プレフィックスで降順。デフォルトは -updated_at)

itemKeyAsPropertyKey
string
Enum: "true" "false"

true の場合、contactCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します

Responses

Response samples

Content type
application/json
{
  • "contacts": [
    ],
  • "hasMore": true,
  • "nextCursor": "string",
  • "totalCount": 0
}

コンタクト情報登録

コンタクト情報を登録し、登録後のコンタクト情報を返します。

  • PAT 認証の場合のみ権限判定を行います
  • レスポンスは contactCustoms を常に含みます
  • ラベル型の詳細項目は value にラベル名の配列を指定します。まだ無いラベル名はラベルが作成されます
  • ラベル名は前後の空白を除き、大文字・小文字を区別せずに既存のラベルと照合します。それ以外の表記の違いは別のラベルとして作成されます
  • 新しく作成するラベル名は100文字以内で、空白を含められません。既存のラベルはコンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)の contactCustomItemLabels で確認できます
  • ラベル数が項目の上限を超える場合は400を返します
  • リクエストの例は、詳細項目の値を型ごとに1つずつ指定します。上から text・url・date・number・decimal_number・single_select(選択肢の value)・multi_select(選択肢の value の配列)・user(ユーザーIDの配列。この例は contactCustomItemId の代わりに itemKey で詳細項目を指定)・label(ラベル名の配列)です
  • レスポンスの例のとおり、詳細項目の値を返すキーは型ごとに違います(text・url・datetime・number・decimalNumber・selectedOption・selectedOptions・selectedUsers・selectedLabels)。値の無い詳細項目も、id が null の要素で返ります
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string

コンタクト名

email
string or null

メールアドレス

tel
string or null

電話番号

mobileTel
string or null

携帯電話番号

address
string or null

住所

dept
string or null

部署

position
string or null

役職

memo
string or null

メモ

object or null

取引先

Array of objects

コンタクト詳細項目

Array of objects

ライフサイクルステージ

Array of objects

関連付けカスタムオブジェクト

  • 一度に登録可能な上限は1000件です

Responses

Request samples

Content type
application/json
{
  • "name": "山田太郎",
  • "contactCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1001,
  • "name": "山田太郎",
  • "email": null,
  • "tel": null,
  • "mobileTel": null,
  • "address": null,
  • "dept": null,
  • "position": null,
  • "memo": null,
  • "marketoLeadScore": null,
  • "customer": null,
  • "createdAt": "2026-10-28T10:30:00+09:00",
  • "updatedAt": "2026-10-28T10:30:00+09:00",
  • "contactCustoms": [
    ]
}

コンタクト情報検索

コンタクト情報を検索します。

  • field の reference (参照先関連オブジェクト) として以下を指定できます。
    • customer (取引先)
  • レスポンスはカーソルページネーション形式 ({ contacts, hasMore, nextCursor, totalCount })
  • filter / sort に指定できる標準項目は、各スキーマの説明に記載のものに限られます(それ以外は 400 になります)
  • 並び順は request body の sort で指定できます(例: name / updated_at / created_at)。省略時は updated_at 降順(id 昇順タイブレーク)
Authorizations:
bearer_auth
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

Request Body schema: application/json
required
required
object (ContactSearchFilter)

絞り込み条件

  • compositeFilter と valueFilter を合わせて最大300個まで指定できます(最上位の compositeFilter は件数に含まれません)。
object (ContactSearchSort)

並び替え条件。省略時は updated_at 降順(id 昇順タイブレーク)。 項目値が未設定のものは、昇順では先頭・降順では末尾に並びます。

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": {
    }
}

Response samples

Content type
application/json
{
  • "contacts": [
    ],
  • "hasMore": true,
  • "nextCursor": "string",
  • "totalCount": 0
}

コンタクト情報

コンタクト詳細を取得します。

  • include_related_objects=1 を指定するとカスタムオブジェクト連携情報(customObjects)を含みます
Authorizations:
bearer_auth
path Parameters
id
required
integer

コンタクトID

query Parameters
itemKeyAsPropertyKey
string
Enum: "true" "false"

true の場合、contactCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します

include_related_objects
integer
Default: 0

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "marketoLeadScore": 0,
  • "customer": {
    },
  • "lifecycleStages": [
    ],
  • "contactCustoms": [
    ],
  • "customObjects": [
    ],
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00"
}

コンタクト情報更新

コンタクト情報を更新します。指定した属性だけを更新します。

  • PAT 認証の場合のみ権限判定を行います
  • レスポンスは更新後のコンタクトを data で包まずに返し、contactCustoms を常に含みます
  • 詳細項目の値を空にするときは "value": null を送ります
  • ラベル型の詳細項目は value にラベル名の配列を指定します。まだ無いラベル名はラベルが作成されます
  • ラベル名は前後の空白を除き、大文字・小文字を区別せずに既存のラベルと照合します。それ以外の表記の違いは別のラベルとして作成されます
  • 新しく作成するラベル名は100文字以内で、空白を含められません。既存のラベルはコンタクト詳細項目設定情報(GET /v2/contact_setting/contact_custom_items)の contactCustomItemLabels で確認できます
  • ラベル数が項目の上限を超える場合は400を返します
  • ラベル型の詳細項目は、指定した一覧でその項目のラベルを置き換えます。空配列・null・value の省略で全て外れ、ラベル型の項目を送らなければ変わりません
  • どのコンタクトにも付かなくなったラベルは自動で削除されます
  • 付いているラベルは取得のレスポンスの selectedLabels で確認できます
  • リクエストの例は、詳細項目の値を型ごとに1つずつ指定します。上から text・url・date・number・decimal_number・single_select(選択肢の value)・multi_select(選択肢の value の配列)・user(ユーザーIDの配列。この例は contactCustomItemId の代わりに itemKey で詳細項目を指定)・label(ラベル名の配列)です
  • レスポンスの例のとおり、詳細項目の値を返すキーは型ごとに違います(text・url・datetime・number・decimalNumber・selectedOption・selectedOptions・selectedUsers・selectedLabels)。値の無い詳細項目も、id が null の要素で返ります
Authorizations:
bearer_auth
path Parameters
id
required
integer

コンタクトID

Request Body schema: application/json
name
string

コンタクト名

email
string or null

メールアドレス

tel
string or null

電話番号

mobileTel
string or null

携帯電話番号

address
string or null

住所

dept
string or null

部署

position
string or null

役職

memo
string or null

メモ

object or null

取引先

Array of objects

コンタクト詳細項目

Array of objects

ライフサイクルステージ

Array of objects

関連付けカスタムオブジェクト

  • 一度に登録可能な上限は1000件です

Responses

Request samples

Content type
application/json
{
  • "contactCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1001,
  • "name": "山田太郎",
  • "email": null,
  • "tel": null,
  • "mobileTel": null,
  • "address": null,
  • "dept": null,
  • "position": null,
  • "memo": null,
  • "marketoLeadScore": null,
  • "customer": null,
  • "createdAt": "2026-10-28T10:30:00+09:00",
  • "updatedAt": "2026-10-28T10:30:00+09:00",
  • "contactCustoms": [
    ]
}

コンタクト情報削除

  • コンタクト情報を削除
  • PAT 認証時のみ権限判定が実行されます
  • コンタクトアクションも削除されます。案件との紐付けは解除されます(案件や案件アクションは削除されません)
Authorizations:
bearer_auth
path Parameters
id
required
integer

コンタクトID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

コンタクトアクション(ContactActions)

コンタクトアクション情報リスト

指定したコンタクトに紐づくアクション一覧をカーソルページネーション形式で取得します。

  • レスポンスは v1 と同じ actions キーの配列を含む構造({ actions, hasMore, nextCursor, totalCount })
  • dataType 未指定時はコンタクトアクション(1)・案件アクション(0)の両方を返します
  • v1 互換: contact_id に all を指定すると全コンタクトのアクションを対象とします
Authorizations:
bearer_auth
path Parameters
required
integer or string

コンタクトIDを指定してアクションを検索します。

コンタクトIDの代わりに、allと指定することでコンタクトIDを跨いだアクションの取得が可能です。 この場合、アクションに紐づくコンタクトのうち1件(コンタクトID昇順の先頭)が contact に返ります。

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数(1〜1000、デフォルト100)

cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

sort
string
Default: "-startDatetime"
Enum: "startDatetime" "-startDatetime" "start_datetime" "-start_datetime"

並び順 ソート可能 startDatetime (- プレフィックスで降順。デフォルトは -startDatetime)

dataType
integer
Enum: 0 1

アクション種別での絞り込み(0:案件アクション / 1:コンタクトアクション)。未指定時は両方

startDatetime
string <date-time>
Example: startDatetime=2018-04-01T10:30:00+09:00

開始日時。タイムゾーンを明示すること(省略時はUTCとして解釈される)

endDatetime
string <date-time>
Example: endDatetime=2018-04-01T10:30:00+09:00

終了日時。タイムゾーンを明示すること(省略時はUTCとして解釈される)

createdAtFrom
string <date-time>
Example: createdAtFrom=2018-04-01T10:30:00+09:00

登録日時開始時間。タイムゾーンを明示すること(省略時はUTCとして解釈される)

createdAtTo
string <date-time>
Example: createdAtTo=2018-04-01T10:30:00+09:00

登録日時終了時間。タイムゾーンを明示すること(省略時はUTCとして解釈される)

updatedAtFrom
string <date-time>
Example: updatedAtFrom=2018-04-01T10:30:00+09:00

最終更新日時開始時間。タイムゾーンを明示すること(省略時はUTCとして解釈される)

updatedAtTo
string <date-time>
Example: updatedAtTo=2018-04-01T10:30:00+09:00

最終更新日時終了時間。タイムゾーンを明示すること(省略時はUTCとして解釈される)

users[][id]
Array of integers

担当者IDによる絞り込み(複数指定可)

pattern
integer

アクションの種別

active
string
Enum: "true" "false"

true:予定 false:完了

Responses

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "hasMore": true,
  • "nextCursor": "string",
  • "totalCount": 0
}

コンタクトアクション登録

コンタクトアクションを登録します。

  • pattern / startDatetime / endDatetime / creator は必須です
  • レスポンスには actionCustoms(アクション詳細)を常に含めます
  • 日時は JST (+09:00) で返します
Authorizations:
bearer_auth
path Parameters
contact_id
required
integer

コンタクトID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
Request Body schema: application/json
required
startDatetime
required
string <date-time>

開始日時

endDatetime
required
string <date-time>

終了日時

required
object

アクション担当者ID

Array of objects

他の担当者

preNote
string

アクションの事前メモ

result
string

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

required
object

アクション種別

Array of objects

アクション詳細項目一覧

Array of objects

アクションに紐づける他のコンタクト

Responses

Request samples

Content type
application/json
{
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "creator": {
    },
  • "invitees": [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "pattern": {
    },
  • "actionCustoms": [
    ],
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "dataType": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "contact": {
    },
  • "deal": {
    },
  • "actionCustoms": [
    ]
}

コンタクトアクション情報

コンタクトアクション詳細を取得します。

  • include_files=1 を指定するとファイル添付情報(files)を含みます
Authorizations:
bearer_auth
path Parameters
contact_id
required
integer

コンタクトID

id
required
integer

アクションID

query Parameters
include_files
string
Default: "0"
Enum: "0" "1"

1 を指定すると、添付ファイルの情報を含めて返します。

Responses

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "id": 0,
  • "dataType": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "contact": {
    },
  • "deal": {
    },
  • "actionCustoms": [
    ]
}

コンタクトアクション情報更新

コンタクトアクション情報を更新します。

  • 指定したフィールドのみ更新します(部分更新)
  • 更新後のレスポンスには actionCustoms(アクション詳細)を常に含めます
Authorizations:
bearer_auth
path Parameters
contact_id
required
integer

コンタクトID

id
required
integer

アクションID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。
Request Body schema: application/json
startDatetime
string <date-time>

開始日時

endDatetime
string <date-time>

終了日時

object

アクション担当者ID

Array of objects

他の担当者

preNote
string

アクションの事前メモ

result
string

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

object

アクション種別

Array of objects

アクション詳細項目一覧

Responses

Request samples

Content type
application/json
{
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "creator": {
    },
  • "invitees": [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "pattern": {
    },
  • "actionCustoms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "dataType": 0,
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "active": true,
  • "syncCalendar": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "result": "string",
  • "extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
  • "pattern": {
    },
  • "creator": {
    },
  • "invitees": [
    ],
  • "contact": {
    },
  • "deal": {
    },
  • "actionCustoms": [
    ]
}

コンタクトアクション情報削除

コンタクトアクションを削除します。

  • 削除成功時はレスポンスボディなしで 200 を返す(v1同様。204は返さない)
Authorizations:
bearer_auth
path Parameters
contact_id
required
integer

コンタクトID

id
required
integer

アクションID

query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱い(通知設定に従う)で、400にはなりません。

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

コンタクトアクション一括登録

コンタクトアクションを一括登録します。

  • v1 と同様に同期実行し、作成されたアクションIDの配列を返します。
  • 1リクエストあたりの上限は1000件です。
  • 1件でもエラーがある場合は全件ロールバックします。
Authorizations:
bearer_auth
query Parameters
skipNotice
string
Enum: "true" "false"

true を指定すると、このAPIコールに起因する通知(ベル通知・メール・プッシュ通知)を送信しません。 個人の通知設定で通知ONの場合でも、本パラメータが優先されます。

  • 本エンドポイント(一括登録/更新)はそもそも通知を送信しないため、指定しても効果はありません。
  • 後方互換のため 1 も true として扱います。
  • false および不正値は未指定と同じ扱いで、400にはなりません。
Request Body schema: application/json
required
Array of objects <= 1000 items

登録するコンタクトアクション一覧

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

ライフサイクルステージ設定(LifecycleStageSetting)

ライフサイクルステージ設定

ライフサイクルステージ種別と、それに紐づくライフサイクルステージの一覧を取得します。

  • ライフサイクルステージをご契約でない場合、lifecycleStageTypes は空配列です
  • ライフサイクルステージを追加・名前変更・並べ替え・削除するときは、この結果を編集してライフサイクルステージ設定更新(PATCH /v2/lifecycle_stage_setting)に送れます
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "lifecycleStageTypes": [
    ]
}

ライフサイクルステージ設定更新

ライフサイクルステージの追加・名前変更・並べ替え・削除を1回で行います。

  • ライフサイクルステージ設定(GET /v2/lifecycle_stage_setting)の結果を編集して送れます。そのまま送ると何も変わりません
  • リクエストに記載の無いキーは無視されます
  • ライフサイクルステージ種別は「標準」の1つだけで、作成・名前変更・削除はできません。種別の id・name は取得結果の値をそのまま指定します
  • lifecycleStageTypes・lifecycleStages の省略と空配列は変更なしです。送らなかったライフサイクルステージは変わりません
  • lifecycleStages の要素は、id を指定すると更新、id を省略すると追加、deleted: true を付けると削除になります。削除は id と一緒に指定します
  • 並び順は送った一覧の順です。全体を並べ替えるときは全ライフサイクルステージを送ります。一部だけ送ると、送ったライフサイクルステージはそれらが今いる位置の中で送った順に並び、送らなかったライフサイクルステージは位置を変えません
  • 追加したライフサイクルステージは、一覧で次にある既存のライフサイクルステージの直前に入ります。後ろに既存が無ければ最後の既存の直後に、既存を1つも送らなければ先頭に入ります
  • 名前は1〜100文字です。前後の空白は除かずに保存し、空白だけの名前も受けます。名前の文字数は変えた名前だけを検査します。名前を変えると、全ユーザーの表示が変わります
  • 並べ替えると、ライフサイクルステージ自動更新で「前のステージに戻さない」ときの前後の判定も変わります
  • 次の条件にあたるライフサイクルステージは削除できません。対処をしてから再実行してください
削除できない条件 対処
コンタクトに付いている そのコンタクトのライフサイクルステージを変える
オートメーションの条件・「コンタクトを更新」で使われている(停止中のオートメーションを含む) オートメーションを変える
Webフォームの初期値に指定されている(Webフォーム機能が有効な場合だけ) フォームの初期値を変える
ライフサイクルステージ自動更新で使われている 自動更新の設定を変える
削除するとライフサイクルステージが1つも残らない 追加と一緒に送る
  • 削除できないときは、エラーに使用先の名前(オートメーション名・フォーム名・案件タイプ名とフェーズ名)を表示します
  • id を省略した要素を含む本文を再送すると、ライフサイクルステージが重複して追加されます
  • PAT の場合、管理者設定の権限が必要です(TAT では権限を判定しません)
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: lifecycleStageTypes[0].lifecycleStages[1].name)を文頭に付けて最初の1件を返します
  • ライフサイクルステージをご契約でない場合は403です(取得では lifecycleStageTypes が空配列です)
  • レスポンスはライフサイクルステージ設定と同じ形です
  • リクエストの例は、ライフサイクルステージ11の後ろに「MQL」を追加し、12の名前を変え、13を削除します。種別の id は取得結果の値をそのまま送ります。「MQL」は一覧で次にある既存の12の直前に入ります。送らなかったライフサイクルステージ(例: 14)は名前も位置も変わりません
Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

ライフサイクルステージ種別のリスト。省略・空配列の場合は変更なし

Responses

Request samples

Content type
application/json
{
  • "lifecycleStageTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "lifecycleStageTypes": [
    ]
}

ライフサイクルステージ自動更新設定情報

案件タイプのフェーズごとに、案件がそのフェーズになったときにコンタクトのライフサイクルステージをどう変えるか(ライフサイクルステージ自動更新)を取得します。

  • 案件タイプの全フェーズを、フェーズの並び順で返します。フェーズ名・案件タイプ名は案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})で取得してください
  • lifecycleStageId は、null が「自動更新しない」(フェーズが変わってもステージを変えない)、0 が「未設定に戻す」(コンタクトのステージを未設定にする)、それ以外がそのライフサイクルステージのIDです。ライフサイクルステージ名はライフサイクルステージ設定(GET /v2/lifecycle_stage_setting)で取得してください
  • 削除済みのライフサイクルステージを指している設定は、null(自動更新しない)として返します
  • preventBackwardLifecycleStageAutoUpdate(前のステージに自動更新されないようにする)は全案件タイプに共通の設定です
  • processingStatus が true の間は、コンタクトのライフサイクルステージの付け直しの処理中で、この案件タイプの設定は更新できません
  • 取得結果は、ライフサイクルステージ自動更新設定更新(PATCH 同じパス)にそのまま送れます
  • PAT の場合、権限設定を利用しているドメインでは、コンタクトの編集権限が無いと403、案件タイプの閲覧権限が無いと403になります
  • ライフサイクルステージをご契約でない場合は403です
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

Responses

Response samples

Content type
application/json
{
  • "preventBackwardLifecycleStageAutoUpdate": true,
  • "processingStatus": true,
  • "phaseLifecycleStageMaps": [
    ]
}

ライフサイクルステージ自動更新設定更新

案件タイプのフェーズごとのライフサイクルステージ自動更新と、前のステージに自動更新されないようにする設定を更新します。

  • ライフサイクルステージ自動更新設定情報(GET 同じパス)の結果を編集して送れます。そのまま送ると何も変わりません。リクエストに記載の無いキーは無視されます
  • 送ったフェーズだけが変わり、送らなかったフェーズは変わりません。phaseLifecycleStageMaps・preventBackwardLifecycleStageAutoUpdate の省略は変更なしです
  • lifecycleStageId は、null が「自動更新しない」(フェーズが変わってもステージを変えない)、0 が「未設定に戻す」(コンタクトのステージを未設定にする)、それ以外がそのライフサイクルステージのIDです。キーは省略できません
  • 指定できるのは、この案件タイプのフェーズと、ライフサイクルステージ設定(GET /v2/lifecycle_stage_setting)にあるライフサイクルステージだけです。フェーズIDは案件タイプ設定情報(GET /v2/deal_setting/deal_types/{id})で取得してください
  • フェーズ・ライフサイクルステージのIDは環境ごとに違います。別の環境の取得結果を送るときは、送る先の環境でフェーズ名・ライフサイクルステージ名からIDを引き直してください
  • 設定が変わると、この案件タイプの案件に関連するコンタクト(案件のアクションのコンタクトを含む)のライフサイクルステージを、裏で一括して付け直します。付け直したステージは元に戻せません。設定が変わらなければ付け直しません
  • preventBackwardLifecycleStageAutoUpdate は全案件タイプに共通の設定で、全案件タイプの自動更新にかかります。変えたときに付け直すのは、指定した案件タイプの案件のコンタクトだけです
  • preventBackwardLifecycleStageAutoUpdate が true の間は、前のステージへの付け直しと「未設定に戻す」は行いません。前後はライフサイクルステージの並び順で判定します
  • 付け直しの処理中(processingStatus が true)は、この案件タイプの設定を更新できず、何も変えない送信も400になります。完了すると通知が届きます。PAT は実行したユーザーに、TAT は管理者設定の権限を持つユーザーそれぞれに届きます
  • 付け直すときは、削除済みのライフサイクルステージを指している設定を「自動更新しない」に直します
  • 削除したフェーズの設定は使われず、取得にも出ません。自動更新で使っているライフサイクルステージは、ライフサイクルステージ設定更新(PATCH /v2/lifecycle_stage_setting)で削除できません
  • 1件でもエラーがあれば何も更新されません。入力エラーの messages は、誤りのある場所(例: phaseLifecycleStageMaps[1].lifecycleStageId)を文頭に付けて最初の1件を返します
  • 500 が返った場合、設定は保存済みですが、コンタクトのライフサイクルステージの付け直しは行われていません。同じ内容を再送しても設定が変わらないため付け直されません。付け直すには画面から保存し直してください
  • PAT の場合、管理者設定の権限と、対象の案件タイプの閲覧権限が必要です(TAT では権限を判定しません)
  • ライフサイクルステージをご契約でない場合は403です
  • レスポンスはライフサイクルステージ自動更新設定情報と同じ形です
  • リクエストの例は、フェーズ201をライフサイクルステージ12に、202を「未設定に戻す」(0)に、203を「自動更新しない」(null)にします
Authorizations:
bearer_auth
path Parameters
deal_type_id
required
integer

案件タイプID

Request Body schema: application/json
required
preventBackwardLifecycleStageAutoUpdate
boolean or null

前のステージに自動更新されないようにする(全案件タイプに共通の設定)。省略・null の場合は変更なし

Array of objects

フェーズごとの自動更新の設定のリスト。省略・空配列の場合は変更なし。null は指定不可(400)

Responses

Request samples

Content type
application/json
{
  • "preventBackwardLifecycleStageAutoUpdate": true,
  • "phaseLifecycleStageMaps": [
    ]
}

Response samples

Content type
application/json
{
  • "preventBackwardLifecycleStageAutoUpdate": true,
  • "processingStatus": true,
  • "phaseLifecycleStageMaps": [
    ]
}

カスタムオブジェクト設定(CustomObjectSetting)

カスタムオブジェクト定義情報リスト

カスタムオブジェクト定義の一覧を取得します。

  • レスポンスは v1同様の customObjectDefs キー({ totalCount, page, customObjectDefs })
  • v1同様の page によるページ方式(1ページあたり100件固定。取得件数の指定はできません)
  • 一覧は項目定義(customObjectItemDefs)を含みません。項目定義はカスタムオブジェクト定義情報(GET /v2/custom_object_defs/{key})で取得してください
  • PAT の場合、権限設定を利用しているドメインでは閲覧権限のないカスタムオブジェクト定義は一覧に含まれません
Authorizations:
bearer_auth
query Parameters
page
integer >= 1
Default: 1

ページ番号(1始まり)。未指定時は1ページ目

searchWord
string

名前が部分一致するカスタムオブジェクト定義を検索します

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "customObjectDefs": [
    ]
}

カスタムオブジェクト定義情報登録

カスタムオブジェクト定義を登録します。

  • 定義・項目定義・選択肢定義を1リクエストでまとめて登録できます
  • レスポンスは登録した定義を単件取得と同じ形で返します
  • 項目定義の並び順はリクエストの順序になります
  • このAPIを使って登録した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)
Authorizations:
bearer_auth
Request Body schema: application/json
required
name
required
string

カスタムオブジェクト名

enableBi
boolean

BIのデータソースとして使用するかどうか

key
string

カスタムオブジェクト定義キー。省略時は自動採番されます

Array of objects (CustomObjectItemDefInput)

項目定義一覧

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enableBi": true,
  • "key": "string",
  • "customObjectItemDefs": [
    ]
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "enableBi": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customObjectItemDefs": [
    ]
}

カスタムオブジェクト定義情報

カスタムオブジェクト定義の情報を項目定義とあわせて取得します。

  • 選択肢(customObjectOptionDefs)は単一選択・複数選択タイプの項目のみが持ちます
  • PAT の場合、権限設定を利用しているドメインでは閲覧権限のないカスタムオブジェクト定義は 403 になります
Authorizations:
bearer_auth
path Parameters
key
required
string

カスタムオブジェクト定義キー

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "enableBi": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customObjectItemDefs": [
    ]
}

カスタムオブジェクト定義情報更新

カスタムオブジェクト定義を更新します。

  • 定義そのものの更新に加えて、項目定義・選択肢定義の追加・更新・削除を1リクエストで行えます
  • 項目定義は key で既存を特定します。既存に無い key を指定すると新規追加になり itemType が必要です
  • キーを変更する場合は newKey を指定します
  • 削除する場合は delete に true を指定してください
  • 選択肢の必須・登録上限・文字数は、指定した差分を適用した更新後の状態で判定します
  • このAPIを使って更新した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)
Authorizations:
bearer_auth
path Parameters
key
required
string

カスタムオブジェクト定義キー

Request Body schema: application/json
required
name
string

カスタムオブジェクト名

enableBi
boolean

BIのデータソースとして使用するかどうか

newKey
string

新しい定義キーを指定します

Array of objects (CustomObjectItemDefUpdateInput)

項目定義一覧

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enableBi": true,
  • "newKey": "string",
  • "customObjectItemDefs": [
    ]
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "enableBi": true,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customObjectItemDefs": [
    ]
}

カスタムオブジェクト定義情報削除

カスタムオブジェクト定義を削除します。

  • 成功時はレスポンスボディを返しません(200のみ)
  • 項目定義・選択肢定義も一緒に削除されます
  • 登録済みのカスタムオブジェクトがある定義を削除すると、そのカスタムオブジェクトも削除されます
  • このAPIを使って削除した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)
Authorizations:
bearer_auth
path Parameters
key
required
string

カスタムオブジェクト定義キー

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

カスタムオブジェクト項目登録

カスタムオブジェクト定義に項目を1件登録します。

  • before を指定すると、その項目キーの手前に挿入します(省略時は末尾に追加)
  • 単一選択・複数選択タイプでは customObjectOptionDefs の指定が必須です
  • ドメインごとの項目登録上限に達している場合は 400 になります
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

Request Body schema: application/json
required
name
required
string

項目名

itemType
required
string

text: 文字列タイプ

  • text: 文字列タイプ
  • date: 日付タイプ
  • number: 整数タイプ
  • decimal_number: 小数タイプ
  • single_select: 単一選択タイプ
  • multi_select: 複数選択タイプ
key
string

項目キー。省略した場合は自動で設定されます

before
string

指定した項目キーの手前に項目を追加します

Array of objects

選択肢定義一覧。単一選択・複数選択タイプでは必須です

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "itemType": "string",
  • "key": "string",
  • "before": "string",
  • "customObjectOptionDefs": [
    ]
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "itemType": "string",
  • "customObjectOptionDefs": [
    ]
}

カスタムオブジェクト項目更新

カスタムオブジェクト定義の項目を1件更新します。

  • 指定しなかった項目・選択肢は変更されません
  • 項目タイプは登録後に変更できないため、リクエストに含めても無視されます
  • 選択肢は key で対象を指定します。存在しない key を指定した場合、または key を省略した場合は選択肢を追加します
  • 存在しない key に delete を指定した場合は、追加も削除もされません
  • customObjectOptionDefs を指定すると、指定した並び順で選択肢の表示順を採番し直します
  • 既存の選択肢名を入れ替える指定(A→B、B→A)は選択肢名が重複するため 400 になります
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

key
required
string

項目キー

Request Body schema: application/json
required
name
string

項目名

newKey
string

新しい項目キーを指定します

Array of objects

選択肢定義一覧。指定した選択肢のみを更新します

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "newKey": "string",
  • "customObjectOptionDefs": [
    ]
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "name": "string",
  • "itemType": "string",
  • "customObjectOptionDefs": [
    ]
}

カスタムオブジェクト項目削除

カスタムオブジェクト定義の項目を削除します。

  • 成功時はレスポンスボディなしで 200 を返します
  • 単一選択・複数選択タイプの項目を削除すると、その選択肢もあわせて削除されます
  • 削除した項目に登録されていたカスタムオブジェクトの値も削除されます
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

key
required
string

項目キー

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

カスタムオブジェクト(CustomObjects)

カスタムオブジェクト情報リスト

カスタムオブジェクトの一覧をカーソルページネーション形式で取得します。

  • 1回あたりの取得件数は100件固定です(limit は指定できません)
  • cursor は 1回目のリクエストと同じ絞り込み条件・sort とあわせて指定してください(異なる場合は 400 を返します)
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

query Parameters
カスタムオブジェクト項目キー
string

カスタムオブジェクト項目定義の「項目キー」を検索キーとして指定します。

検索条件に指定できるのは下記の項目タイプです。

  • 文字列タイプ(text)
  • 整数タイプ(number)
  • 小数タイプ(decimal_number)
  • 日付タイプ(date)

ただし下記の制御用パラメータと同名の項目キーは、検索条件には指定できません。

  • createdAtFrom、createdAtTo
  • updatedAtFrom、updatedAtTo
  • sort、cursor

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名 項目キー 項目タイプ
商品コード productCode number
商品名 productName text
  • 商品コード=123
  • 商品名=サンプル商品

という検索条件を指定する場合、以下のようにクエリパラメータを設定します。

/v2/custom_object_defs/products/custom_objects
  ?productCode=123
  &productName=サンプル商品
cursor
string

次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る

createdAtFrom
string <date-time>

作成日時による検索範囲(開始)

createdAtTo
string <date-time>

作成日時による検索範囲指定(終了)

updatedAtFrom
string <date-time>

更新日時による検索範囲(開始)

updatedAtTo
string <date-time>

更新日時による検索範囲指定(終了)

sort
string
Enum: "createdAt" "updatedAt"

並び順 ソート可能 updatedAt、createdAt(昇順固定)

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "hasMore": true,
  • "nextCursor": "string",
  • "customObjects": [
    ]
}

カスタムオブジェクト情報登録

カスタムオブジェクトを登録します。

  • deals / customers / contacts で案件・取引先・コンタクトへの関連付けを同時に登録できます(1オブジェクトあたり最大1000件)
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

Request Body schema: application/json
required
カスタムオブジェクト項目
any

カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。

項目タイプごとに以下の値を設定してください。

  • 文字列タイプ(text)
    • type: string
  • 日付タイプ(date)
    • type: string
    • ISO 8601形式文字列
    • ex) 2023-04-22T00:02:03+09:00
  • 整数タイプ(number)
    • type: integer
  • 小数タイプ(decimal_number)
    • type: string
  • URLタイプ(url)
    • type: string
  • 単一選択タイプ(single_select)
    • type: string
    • 選択肢キー
  • 複数選択タイプ(multi_select)
    • type: Array of string
    • 選択肢キーの配列
  • ユーザータイプ(user)
    • type: Array of integer
    • ユーザーIDの配列

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名 項目キー 項目タイプ
商品コード productCode number
商品名 productName text
  • 商品コード=123
  • 商品名=サンプル商品

というデータを追加するリクエストペイロードは以下になります。

  {
    "productCode": 123,
    "productName": "サンプル商品"
  }
Array of objects

関連付け案件

Array of objects

関連付け取引先

Array of objects

関連付けコンタクト

Responses

Request samples

Content type
application/json
{
  • "カスタムオブジェクト項目": null,
  • "deals": [
    ],
  • "customers": [
    ],
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "textKey": "string",
  • "dateKey": "2018-04-01T10:30:00+09:00",
  • "numberKey": 0,
  • "decimalKey": "string",
  • "urlKey": "string",
  • "singleKey": {
    },
  • "multiKey": [
    ],
  • "userKey": [
    ],
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00"
}

カスタムオブジェクト情報

指定したカスタムオブジェクトを取得します。

  • include_related_objects=1 を指定すると、関連付けオブジェクトの情報を含めて返します
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

id
required
integer

カスタムオブジェクトID

query Parameters
include_related_objects
integer

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "textKey": "string",
  • "dateKey": "2018-04-01T10:30:00+09:00",
  • "numberKey": 0,
  • "decimalKey": "string",
  • "urlKey": "string",
  • "singleKey": {
    },
  • "multiKey": [
    ],
  • "userKey": [
    ],
  • "deals": [
    ],
  • "customers": [
    ],
  • "contacts": [
    ],
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00"
}

カスタムオブジェクト情報更新

カスタムオブジェクトを更新します。リクエストに含まれた項目のみ更新されます(部分更新)。

  • null または空文字を指定すると項目値を削除します
  • 関連付け(deals / customers / contacts)は { "id": N } で追加、{ "id": N, "delete": true } で解除します
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

id
required
integer

カスタムオブジェクトID

Request Body schema: application/json
required
カスタムオブジェクト項目
any

カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。

項目タイプごとに以下の値を設定してください。

  • 文字列タイプ(text)
    • type: string
  • 日付タイプ(date)
    • type: string
    • ISO 8601形式文字列
    • ex) 2023-04-22T00:02:03+09:00
  • 整数タイプ(number)
    • type: integer
  • 小数タイプ(decimal_number)
    • type: string
  • URLタイプ(url)
    • type: string
  • 単一選択タイプ(single_select)
    • type: string
    • 選択肢キー
  • 複数選択タイプ(multi_select)
    • type: Array of string
    • 選択肢キーの配列
  • ユーザータイプ(user)
    • type: Array of integer
    • ユーザーIDの配列

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名 項目キー 項目タイプ
商品コード productCode number
商品名 productName text
  • 商品コード=123
  • 商品名=サンプル商品

というデータを追加するリクエストペイロードは以下になります。

  {
    "productCode": 123,
    "productName": "サンプル商品"
  }

Responses

Request samples

Content type
application/json
{
  • "カスタムオブジェクト項目": null
}

Response samples

Content type
application/json
{ }

カスタムオブジェクト情報削除

指定したカスタムオブジェクトを削除します。

  • 成功時はレスポンスボディなしで 200 を返す(v1同様)
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

id
required
integer

カスタムオブジェクトID

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

カスタムオブジェクト情報一括登録

カスタムオブジェクトを一括登録します(v1同様の同期実行)。

  • 成功時は作成したカスタムオブジェクトIDの配列を返します
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です。
  • このAPIを使って登録した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)。
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

Request Body schema: application/json
required
required
Array of objects (CustomObjectBulkCreateItem) <= 1000 items

登録するカスタムオブジェクトの配列。各要素はカスタムオブジェクト項目定義のキーをプロパティとして指定

Responses

Request samples

Content type
application/json
{
  • "customObjects": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

カスタムオブジェクト情報一括更新

カスタムオブジェクトを一括更新します(v1同様の同期実行)。

  • 成功時は更新したカスタムオブジェクトIDの配列を返します
  • 処理はall-or-nothingで、1件でも失敗すると全件ロールバックされます
  • 1リクエストあたりの上限は 1000 件です。
  • 同じIDが複数回指定された場合、最後の行の値が採用されます。
  • このAPIを使って更新した場合、PAT認証時のみ監査ログが記録されます(TAT認証時は記録されません)。
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

Request Body schema: application/json
required
required
Array of objects (CustomObjectBulkUpdateItem) <= 1000 items

更新するカスタムオブジェクトの配列。各要素は更新対象の id と、カスタムオブジェクト項目定義のキーをプロパティとして指定

Responses

Request samples

Content type
application/json
{
  • "customObjects": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

カスタムオブジェクト情報一括削除(条件指定)

条件に一致するカスタムオブジェクトを一括削除します。

  • 成功時はレスポンスボディなしで 200 を返す
  • 条件を1つも指定しない場合、その定義のカスタムオブジェクトを全件削除します
  • ID を指定して削除する場合は POST /v2/custom_object_defs/{custom_object_def_key}/custom_objects/bulk_delete を使用してください
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

query Parameters
createdAtFrom
string <date-time>

作成日時による検索範囲(開始)

createdAtTo
string <date-time>

作成日時による検索範囲指定(終了)

updatedAtFrom
string <date-time>

更新日時による検索範囲(開始)

updatedAtTo
string <date-time>

更新日時による検索範囲指定(終了)

Responses

Response samples

Content type
application/json
{
  • "error": "The access token is invalid."
}

カスタムオブジェクト情報一括削除(ID指定)

リクエストボディで指定したIDのカスタムオブジェクトを一括削除します。

  • 成功時はレスポンスボディなしで 200 を返す
  • customObjectIds が空配列・未指定の場合は1件も削除しません
  • 日時範囲などの条件を指定して削除する場合は DELETE /v2/custom_object_defs/{custom_object_def_key}/custom_objects/bulk を使用してください
Authorizations:
bearer_auth
path Parameters
custom_object_def_key
required
string

カスタムオブジェクト定義キー

Request Body schema: application/json
customObjectIds
Array of integers <= 1000 items

カスタムオブジェクトIDのリスト。最大1000件

Responses

Request samples

Content type
application/json
{
  • "customObjectIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "messages": [
    ]
}

オブジェクト名称(ObjectLabels)

オブジェクト名称取得

  • 基本オブジェクト(取引先・案件・コンタクト・アクション)の名称を取得します
  • label は実際に表示されている名称です。名称が変更されていない場合は defaultLabel と同じ値を返します
  • defaultLabel はシステム標準の名称です
Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "customer": {
    },
  • "deal": {
    },
  • "contact": {
    },
  • "action": {
    }
}

オブジェクト名称更新

  • 基本オブジェクト(取引先・案件・コンタクト・アクション)の名称を変更します
  • リクエストに含めたオブジェクトのみ更新し、含めないオブジェクトは変更しません
  • null を指定するとシステム標準の名称に戻します
  • 名称は10文字以内・改行不可で、4オブジェクト間で重複できません
  • 未知のオブジェクト種別、および文字列でもnullでもない値は400で拒否します
  • レスポンスは GET /v2/object_labels と同一形式の、更新後の名称です
  • 個人トークン(PAT)で実行する場合は「管理者設定」権限が必要です
Authorizations:
bearer_auth
Request Body schema: application/json
required
customer
string or null <= 10 characters

取引先に設定する名称(10文字以内・改行不可)。null でシステム標準の名称に戻す

deal
string or null <= 10 characters

案件に設定する名称(10文字以内・改行不可)。null でシステム標準の名称に戻す

contact
string or null <= 10 characters

コンタクトに設定する名称(10文字以内・改行不可)。null でシステム標準の名称に戻す

action
string or null <= 10 characters

アクションに設定する名称(10文字以内・改行不可)。null でシステム標準の名称に戻す

Responses

Request samples

Content type
application/json
{
  • "customer": "string",
  • "deal": "string",
  • "contact": "string",
  • "action": "string"
}

Response samples

Content type
application/json
{
  • "customer": {
    },
  • "deal": {
    },
  • "contact": {
    },
  • "action": {
    }
}

監査ログ(Audits)

監査ログ取得

監査ログの一覧をv1同様のページ方式で取得します。

  • 操作日時(time)の昇順で返します
  • 一度に取得できる件数は1000件で、page を指定して続きを取得します
Authorizations:
bearer_auth
query Parameters
page
integer >= 1
Default: 1

ページ番号(1始まり)。未指定時は1ページ目

startTime
string <date-time>

開始日時。例 2025-04-01T00:00:00+09:00。タイムゾーンを省略した場合は日本時間として解釈します。日時として解釈できない値は無視されます

endTime
string <date-time>

終了日時。例 2025-04-30T23:59:59+09:00。タイムゾーンを省略した場合は日本時間として解釈します。日時として解釈できない値は無視されます

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "page": 0,
  • "audits": [
    ]
}

API改訂履歴

更新日API内容
2026/11/11取引先設定(CustomerSetting)
アクション設定(ActionSetting)
案件設定(DealSetting)
コンタクト設定(ContactSetting)
ライフサイクルステージ設定(LifecycleStageSetting)
各オブジェクトの設定(詳細項目・詳細項目グループ・案件タイプ・アクション設定など)を取得・登録・更新・削除するAPIを新規追加
2026/10/14オブジェクト名称(ObjectLabels)オブジェクト名称を取得・更新するAPIを新規追加