Download OpenAPI specification:
オンラインマニュアル: MazricaAPIを利用する – Mazrica
API のエンドポイントのベース URL は以下です。バージョンの v2 を含めてリクエストしてください。
https://api.mazrica.com/v2/{PATH_TO_REQUEST}
認証は 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'
mzp_): 権限設定 を利用しているドメインでは、トークンを発行したユーザーの権限が適用されます。閲覧・操作できる範囲はそのユーザーのロールに従い、権限外のデータは取得・操作できません。一覧・検索では権限のあるデータのみがヒットし、権限不足でも 403 ではなくスコープ内の結果(該当なしの場合は空)を返します。権限設定 を利用していないドメインでは制限はありません。mzt_): ユーザー権限による絞り込みはなく、ドメイン内のデータを制限なく操作できます。レート制限を超えた場合は 429 Too Many Requests を返します。日次の上限は UTC 0 時境界でリセットされます。
| トークン種別 | 集計単位 | 秒間上限 | 日次上限 |
|---|---|---|---|
PAT (mzp_) |
ユーザー単位(同一ユーザーの複数 PAT と、MCP 連携経由の利用を合算) | 5 req/sec | 50,000 |
TAT (mzt_) |
ドメイン単位(同一ドメインの複数 TAT を合算) | 5 req/sec | 200,000 |
一覧を返す API は sort クエリパラメータで並び順を指定できます。キーの前に - を付けると降順になります。指定できるキーと既定の並び順はエンドポイントごとに異なるため、各エンドポイントの sort パラメータの説明を参照してください。
GET /v2/customers?sort=createdAt(作成日時の昇順)、GET /v2/customers?sort=-updatedAt(更新日時の降順)検索エンドポイント(/v2/contacts/search、/v2/deals/search)では、リクエストボディの sort で指定します。
{
"sort": { "field": { "name": "updated_at" }, "order": "DESC" }
}
field.name: ソート対象の標準項目名を指定します(updatedAt 等 camelCase も可)order: ASC(昇順)/ DESC(降順)permissions には、そのユーザーが持つ権限の識別子が入ります{- "id": 0,
- "name": "string",
- "email": "string",
- "domainId": 0,
- "profile": {
- "id": 0,
- "name": "string"
}, - "permissions": [
- "string"
]
}| page | integer >= 1 Default: 1 ページ番号(1始まり)。未指定時は1ページ目 |
| deleted | integer Default: 0 Enum: 0 1
|
string 指定したEメールアドレスのユーザーのみ取得します |
{- "users": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "userGroups": [
- {
- "id": 0,
- "name": "string"
}
], - "profile": {
- "id": 0,
- "name": "string"
}, - "role": {
- "id": 0,
- "name": "string"
}
}
], - "totalCount": 0,
- "page": 0
}ユーザーグループ一覧をv1同様のページ方式で取得します。
userGroups キー ({ userGroups, totalCount, page })userId を指定すると、そのユーザーが所属するグループのみ返す| page | integer >= 1 Default: 1 ページ番号(1始まり)。未指定時は1ページ目 |
| userId | integer ユーザーID |
{- "userGroups": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0,
- "users": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
]
}
], - "totalCount": 0,
- "page": 0
}ユーザーグループの属性を更新します。
| id required | integer ユーザーグループID |
| name | string <= 255 characters ユーザーグループ名 |
{- "name": "string"
}{- "id": 0,
- "name": "string",
- "orderNum": 0
}ユーザーグループにメンバー(ユーザー)を1人追加します。
mzp_xxx) または TAT (mzt_xxx) の Bearer トークン| userGroupId required | integer ユーザーグループID |
| userId | integer 指定したユーザーグループに追加するユーザーのID
|
{- "userId": 0
}{- "id": 0,
- "name": "string",
- "orderNum": 0,
- "users": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
]
}ユーザーグループから指定メンバー(ユーザー)を除外します。
mzp_xxx) または TAT (mzt_xxx) の Bearer トークン{userId} は除外するユーザーのID| userGroupId required | integer ユーザーグループID |
| userId required | integer ユーザーID |
{- "error": "The access token is invalid."
}ユーザーグループのメンバーを userIds で完全置換します(追加ではありません)。
mzp_xxx) または TAT (mzt_xxx) の Bearer トークンuserIds に含まれない既存メンバーは除外されます。空配列 [] を指定すると全メンバーを除外しますuserIds を省略した場合はメンバーを変更せず 200 を返します| userGroupId required | integer ユーザーグループID |
| userIds | Array of integers or null ユーザーID(複数指定)
|
{- "userIds": [
- 0
]
}{- "id": 0,
- "name": "string",
- "orderNum": 0,
- "users": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
]
}取引先詳細項目の定義の一覧と、取引先一覧の期間別カラーラベルを取得します。
orderNum)の昇順で返しますcustomItemOptions)は itemType が single_select / multi_select の項目のみ値が設定されますcustomerSearchActionRanges)は並び順(orderNum)の昇順で返します。画面ではカラーラベルは3件で、追加・削除できません。色は画面で変更できませんid は null になりますcustomerCustomItems)は v1 と同じ形の簡易な一覧で、取引先詳細項目グループ・画面上の並び・表示形式(uiMode)を含みません。それらが要る時は取引先詳細項目設定情報(GET /v2/customer_setting/customer_custom_items)を使いますitemType を multi_select で返します。取引先詳細項目設定情報は label で返しますid に値が入ります{- "customerCustomItems": [
- {
- "id": 101,
- "name": "業種",
- "orderNum": 0,
- "itemType": "single_select",
- "itemKey": "industry",
- "customItemOptions": [
- {
- "id": 1001,
- "value": 1,
- "label": "製造"
}, - {
- "id": 1002,
- "value": 2,
- "label": "小売"
}
]
}, - {
- "id": 102,
- "name": "設立日",
- "orderNum": 1,
- "itemType": "date",
- "itemKey": null,
- "customItemOptions": [ ]
}
], - "customerSearchActionRanges": [
- {
- "id": null,
- "name": "1週間以内",
- "minDays": 0,
- "maxDays": 7,
- "colorCode": "4CD2FF",
- "orderNum": 0
}, - {
- "id": null,
- "name": "1週間~1ヶ月",
- "minDays": 8,
- "maxDays": 30,
- "colorCode": "FFDF32",
- "orderNum": 1
}, - {
- "id": null,
- "name": "1ヶ月以上",
- "minDays": 31,
- "maxDays": 365,
- "colorCode": "FF7259",
- "orderNum": 2
}
]
}取引先一覧で、直近のアクション完了日からの経過日数に応じて付く色ラベル(カラーラベル)の、名前と経過日数の上限を更新します。
{})で送ります。件数を変えると400になりますArray of objects 取引先一覧の期間別カラーラベル一覧。省略・空配列の場合は変更なし。null は指定不可。取得結果と同じ件数・同じ並びで送り、配列の位置で更新するカラーラベルが決まる。変えないカラーラベルは空のオブジェクト({})で送る。追加・削除はできない |
{- "customerSearchActionRanges": [
- {
- "maxDays": 14
}, - { },
- {
- "name": "要フォロー"
}
]
}{- "customerCustomItems": [ ],
- "customerSearchActionRanges": [
- {
- "id": 11,
- "name": "1週間以内",
- "minDays": 0,
- "maxDays": 14,
- "colorCode": "4CD2FF",
- "orderNum": 0
}, - {
- "id": 12,
- "name": "1週間~1ヶ月",
- "minDays": 15,
- "maxDays": 30,
- "colorCode": "FFDF32",
- "orderNum": 1
}, - {
- "id": 13,
- "name": "要フォロー",
- "minDays": 31,
- "maxDays": 365,
- "colorCode": "FF7259",
- "orderNum": 2
}
]
}取引先詳細項目の定義を一括で登録・更新・削除します(同期実行)。
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 で返ります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を返します| 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 の場合に指定します。並び順は配列の順序になります。 |
[- {
- "name": "取扱商材",
- "itemType": "multi_select",
- "orderNum": 3,
- "customItemOptions": [
- {
- "label": "A"
}, - {
- "label": "B"
}
]
}, - {
- "id": 102,
- "name": "設立年月日"
}, - {
- "id": 101,
- "customItemOptions": [
- {
- "id": 1001,
- "value": 1,
- "label": "製造業"
}, - {
- "id": 1002,
- "delete": true
}
]
}, - {
- "id": 103,
- "delete": true
}
]{- "customerCustomItems": [
- {
- "id": 101,
- "name": "業種",
- "orderNum": 0,
- "itemType": "single_select",
- "itemKey": "industry",
- "customItemOptions": [
- {
- "id": 1001,
- "value": 1,
- "label": "製造業",
- "orderNum": 1
}
]
}, - {
- "id": 102,
- "name": "設立年月日",
- "orderNum": 1,
- "itemType": "date",
- "itemKey": null,
- "customItemOptions": [ ]
}, - {
- "id": 120,
- "name": "取扱商材",
- "orderNum": 3,
- "itemType": "multi_select",
- "itemKey": null,
- "customItemOptions": [
- {
- "id": 1003,
- "value": 1,
- "label": "A",
- "orderNum": 1
}, - {
- "id": 1004,
- "value": 2,
- "label": "B",
- "orderNum": 2
}
]
}
], - "results": [
- {
- "requestIndex": 0,
- "operation": "created",
- "id": 120
}, - {
- "requestIndex": 1,
- "operation": "updated",
- "id": 102
}, - {
- "requestIndex": 2,
- "operation": "updated",
- "id": 101
}, - {
- "requestIndex": 3,
- "operation": "deleted",
- "id": 103
}
]
}ドメインに設定された取引先詳細項目と取引先詳細項目グループを、設定画面と同じ並びで取得します。
{ "layout": [...] } の形で、全件を1回で返します(ページングはありません)1(プルダウン)か 2(ラジオボタン)、multi_select が 1(プルダウン)か 3(チェックボックス)、itemType が label の項目が 4(ラベル)です。それ以外の itemType の項目と、表示形式が設定されていない選択型の項目(一括登録(POST /v2/customer_setting/bulk)で作った項目など)は null です{- "layout": [
- {
- "customerCustomItem": null,
- "customerCustomItemGroup": {
- "id": 12,
- "name": "基本情報",
- "customerCustomItems": [
- {
- "id": 201,
- "itemKey": "memo",
- "name": "社内メモ",
- "itemType": "text",
- "uiMode": null,
- "customerCustomItemGroupId": 12,
- "customItemOptions": [ ]
}, - {
- "id": 202,
- "itemKey": null,
- "name": "Webサイト",
- "itemType": "url",
- "uiMode": null,
- "customerCustomItemGroupId": 12,
- "customItemOptions": [ ]
}
]
}
}, - {
- "customerCustomItem": {
- "id": 203,
- "itemKey": null,
- "name": "設立日",
- "itemType": "date",
- "uiMode": null,
- "customerCustomItemGroupId": null,
- "customItemOptions": [ ]
}, - "customerCustomItemGroup": null
}, - {
- "customerCustomItem": {
- "id": 204,
- "itemKey": null,
- "name": "従業員数",
- "itemType": "number",
- "uiMode": null,
- "customerCustomItemGroupId": null,
- "customItemOptions": [ ]
}, - "customerCustomItemGroup": null
}, - {
- "customerCustomItem": {
- "id": 205,
- "itemKey": null,
- "name": "資本金(億円)",
- "itemType": "decimal_number",
- "uiMode": null,
- "customerCustomItemGroupId": null,
- "customItemOptions": [ ]
}, - "customerCustomItemGroup": null
}, - {
- "customerCustomItem": {
- "id": 206,
- "itemKey": "industry",
- "name": "業種",
- "itemType": "single_select",
- "uiMode": 1,
- "customerCustomItemGroupId": null,
- "customItemOptions": [
- {
- "id": 1001,
- "value": 1,
- "label": "製造"
}, - {
- "id": 1002,
- "value": 2,
- "label": "小売"
}
]
}, - "customerCustomItemGroup": null
}, - {
- "customerCustomItem": {
- "id": 207,
- "itemKey": null,
- "name": "取扱商材",
- "itemType": "multi_select",
- "uiMode": 3,
- "customerCustomItemGroupId": null,
- "customItemOptions": [
- {
- "id": 1003,
- "value": 1,
- "label": "A"
}, - {
- "id": 1004,
- "value": 2,
- "label": "B"
}
]
}, - "customerCustomItemGroup": null
}, - {
- "customerCustomItem": {
- "id": 208,
- "itemKey": null,
- "name": "タグ",
- "itemType": "label",
- "uiMode": 4,
- "customerCustomItemGroupId": null,
- "customItemOptions": [
- {
- "id": 1005,
- "value": 1,
- "label": "重点"
}
]
}, - "customerCustomItemGroup": null
}, - {
- "customerCustomItem": {
- "id": 209,
- "itemKey": null,
- "name": "担当営業",
- "itemType": "user",
- "uiMode": null,
- "customerCustomItemGroupId": null,
- "customItemOptions": [ ]
}, - "customerCustomItemGroup": null
}
]
}ドメインに取引先詳細項目を1件、選択肢と合わせて登録します。
| before | 取引先詳細項目の登録 | 取引先詳細項目の更新 | 取引先詳細項目グループの登録 | 取引先詳細項目グループの更新 |
|---|---|---|---|---|
| 省略 | 入れる先(グループ内・グループ外)の末尾 | 位置を変えない(所属を変えた時は移動先の末尾) | 先頭 | 位置を変えない |
null |
入れる先の末尾 | 移動先の末尾 | 指定できない(400) | 末尾 |
{ "customerCustomItemId": n } |
n の前 | n の前 | n の前(グループに入っていない取引先詳細項目のみ) | 同左 |
{ "customerCustomItemGroupId": n } |
n の前(グループ外に入れる時のみ) | 同左 | n の前 | n の前(自分以外) |
別の環境へ同じ並びで複製する手順は次のとおりです。複製先に取引先詳細項目・取引先詳細項目グループが無い場合に、複製元と同じ並びになります。
{"customerCustomItemId": 作った取引先詳細項目の id} か {"customerCustomItemGroupId": 作ったグループの id})| name required | string 取引先詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存 |
| itemType required | string 取引先詳細項目タイプ。以下のいずれか
|
| itemKey | string or null API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。空文字・空白だけの時は null として保存 |
| uiMode | integer or null 表示形式。itemType が single_select・multi_select の時のみ使用。省略・null の時は画面で作成した時と同じ値
|
| customerCustomItemGroupId | integer or null 所属する取引先詳細項目グループID。省略・null の時はグループに入れない |
object or null 並び位置。省略・null の時は入れる先(グループ内・グループ外)の末尾 | |
Array of objects or null (CustomerCustomItemCreateOption) 取引先詳細選択項目リスト。itemType が single_select・multi_select の時は1件以上必須で、配列の順が並び順。それ以外の itemType では空か省略 |
{- "name": "社内メモ",
- "itemType": "text",
- "itemKey": "memo"
}{- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "customerCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}取引先詳細項目1件を、送った項目だけ変更します。省略した項目は変更されません。
| before | 取引先詳細項目の登録 | 取引先詳細項目の更新 | 取引先詳細項目グループの登録 | 取引先詳細項目グループの更新 |
|---|---|---|---|---|
| 省略 | 入れる先(グループ内・グループ外)の末尾 | 位置を変えない(所属を変えた時は移動先の末尾) | 先頭 | 位置を変えない |
null |
入れる先の末尾 | 移動先の末尾 | 指定できない(400) | 末尾 |
{ "customerCustomItemId": n } |
n の前 | n の前 | n の前(グループに入っていない取引先詳細項目のみ) | 同左 |
{ "customerCustomItemGroupId": n } |
n の前(グループ外に入れる時のみ) | 同左 | n の前 | n の前(自分以外) |
| id required | integer 取引先詳細項目ID |
| name | string 取引先詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存 |
| itemType | string 取引先詳細項目タイプ。変更不可(現在の値のみ指定可能) |
| itemKey | string or null API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。null・空文字・空白だけの時は API項目キーを消す |
| uiMode | integer or null 表示形式。itemType が single_select・multi_select の時のみ変更可能。null には変更不可
|
| customerCustomItemGroupId | integer or null 所属する取引先詳細項目グループID。null の時はグループから出す。変更して before を省略した時は移動先の末尾に入る |
object or null 並び位置。省略した時は位置を変えない。null の時は移動先(グループ内・グループ外)の末尾。この取引先詳細項目自身は指定不可 | |
Array of objects or null (CustomerCustomItemUpdateOption) 取引先詳細選択項目リスト(差分)。itemType が single_select・multi_select の時のみ指定可能。送らなかった選択肢は変更しない。省略・null・空配列の時は変更しない。送った選択肢(削除を除く)は配列の順に並び、送らなかった選択肢は位置を保つ。表示形式が |
{- "customItemOptions": [
- {
- "id": 1002,
- "label": "B(改)"
}, - {
- "label": "D"
}, - {
- "id": 1001,
- "deleted": true
}
]
}{- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "customerCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}取引先詳細項目を1件削除します。削除は取り消せません。
| id required | integer 取引先詳細項目ID |
{- "error": "Bad Request",
- "messages": [
- "string"
]
}ドメインに、取引先詳細項目の入っていない取引先詳細項目グループを1件登録します。
| before | 取引先詳細項目の登録 | 取引先詳細項目の更新 | 取引先詳細項目グループの登録 | 取引先詳細項目グループの更新 |
|---|---|---|---|---|
| 省略 | 入れる先(グループ内・グループ外)の末尾 | 位置を変えない(所属を変えた時は移動先の末尾) | 先頭 | 位置を変えない |
null |
入れる先の末尾 | 移動先の末尾 | 指定できない(400) | 末尾 |
{ "customerCustomItemId": n } |
n の前 | n の前 | n の前(グループに入っていない取引先詳細項目のみ) | 同左 |
{ "customerCustomItemGroupId": n } |
n の前(グループ外に入れる時のみ) | 同左 | n の前 | n の前(自分以外) |
| name required | string 取引先詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。同じ名前のグループも登録可能 |
object 並び位置。グループに入っていない取引先詳細項目か取引先詳細項目グループの前に入り、後ろの要素は順にずれる。省略時は先頭。null は指定不可 |
{- "name": "基本情報",
- "before": {
- "customerCustomItemId": 203
}
}{- "id": 0,
- "name": "string",
- "customerCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "customerCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}
]
}取引先詳細項目グループ1件の名前と並び位置を更新します。
| before | 取引先詳細項目の登録 | 取引先詳細項目の更新 | 取引先詳細項目グループの登録 | 取引先詳細項目グループの更新 |
|---|---|---|---|---|
| 省略 | 入れる先(グループ内・グループ外)の末尾 | 位置を変えない(所属を変えた時は移動先の末尾) | 先頭 | 位置を変えない |
null |
入れる先の末尾 | 移動先の末尾 | 指定できない(400) | 末尾 |
{ "customerCustomItemId": n } |
n の前 | n の前 | n の前(グループに入っていない取引先詳細項目のみ) | 同左 |
{ "customerCustomItemGroupId": n } |
n の前(グループ外に入れる時のみ) | 同左 | n の前 | n の前(自分以外) |
| id required | integer 取引先詳細項目グループID |
| name | string 取引先詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。null は指定不可 |
object or null 並び位置。グループに入っていない取引先詳細項目か他の取引先詳細項目グループの前に、中の取引先詳細項目ごと移り、他の要素は順にずれる。null は末尾。省略時は変更しない |
{- "name": "与信情報(改)"
}{- "id": 0,
- "name": "string",
- "customerCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "customerCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}
]
}取引先詳細項目グループ1件を削除します。
| id required | integer 取引先詳細項目グループID |
{- "error": "The access token is invalid."
}アクション詳細項目の定義と、アクション基本項目の説明を取得します。
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)で取得できます{- "actionCustomItems": [
- {
- "id": 100,
- "name": "訪問メモ",
- "itemType": "text",
- "itemKey": "visit_memo",
- "uiMode": null,
- "actionCustomItemOptions": [ ]
}, - {
- "id": 101,
- "name": "商談の温度感",
- "itemType": "single_select",
- "itemKey": "temperature",
- "uiMode": 1,
- "actionCustomItemOptions": [
- {
- "id": 501,
- "value": 1,
- "label": "高"
}, - {
- "id": 502,
- "value": 2,
- "label": "中"
}
]
}, - {
- "id": 102,
- "name": "タグ",
- "itemType": "label",
- "itemKey": "tags",
- "uiMode": null,
- "actionCustomItemOptions": [ ]
}
], - "actionBasicFieldSettings": [
- {
- "field": "pattern",
- "description": null
}, - {
- "field": "purpose_id",
- "description": "商談の段階に合わせて選んでください"
}, - {
- "field": "start_datetime",
- "description": null
}, - {
- "field": "end_datetime",
- "description": null
}, - {
- "field": "user_id",
- "description": null
}, - {
- "field": "sub_user_ids",
- "description": null
}, - {
- "field": "data",
- "description": null
}, - {
- "field": "point",
- "description": null
}
]
}アクション基本項目の説明を更新します。
GET /v2/action_setting)の結果を編集して送れます。そのまま送ると何も変わりませんactionBasicFieldSettings)は、基本項目キー(field)で対象の項目を指定し、送った要素の説明だけが変わります。省略・空配列は変更なしですdescription)を省略した要素の説明は変わりません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 になるため、今の説明はこの更新のレスポンスで確認しますactionBasicFieldSettings[1].description)を文頭に付けて最初の1件を返しますArray of objects 基本項目設定。省略・空配列の場合は変更なし。送った要素の説明だけが変わります |
{- "actionBasicFieldSettings": [
- {
- "field": "pattern",
- "description": "面談・電話など、実施した方法を選ぶ"
}, - {
- "field": "purpose_id",
- "description": null
}, - {
- "field": "data"
}
]
}{- "actionCustomItems": [
- {
- "id": 0,
- "name": "string",
- "itemType": "text",
- "itemKey": "string",
- "uiMode": 0,
- "actionCustomItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}
], - "actionBasicFieldSettings": [
- {
- "field": "pattern",
- "description": "string"
}
]
}取引先アクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を取得します。
data などで包まず、設定のオブジェクトをそのまま返します。全件を1回で返し、ページングはありませんPATCH /v2/action_setting/customer_action_setting)に送れますcustomerActionTemplates)は、アクションの入力画面でテンプレートを選ぶと事前メモ(preNote)・実施結果(result)に差し込まれる文章です。紐付くアクション種別(patterns)のアクションで選べますactionCustomItemScopeSettings)は、取引先アクションの入力画面でのアクション詳細項目の表示・必須です。アクションの登録・更新 API では検査されませんGET /v2/action_setting)のアクション詳細項目と同じで、項目ごとにアクション種別の昇順です。一度も設定していない組み合わせは、表示・必須とも false になりますitemKey)で指します。項目名・項目タイプ・選択肢はアクション設定(GET /v2/action_setting)で取得できます{- "customerActionTemplates": [
- {
- "id": 0,
- "name": "string",
- "actionData": "string",
- "actionPoint": "string",
- "patterns": [
- 1
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "string",
- "pattern": 1,
- "visible": true,
- "required": true
}
]
}取引先アクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を更新します。
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 で保存されますitemKey)とアクション種別(pattern)の組み合わせで指定し、送った組み合わせだけが変わります。項目キーはアクション設定(GET /v2/action_setting)で取得できますvisible: false)組み合わせは必須(required: true)にできませんid の無い要素(追加)を含むリクエストを送り直すと、同じテンプレートがもう1件追加されます。通信の失敗などで送り直すときは、先に取得して追加済みかを確かめてくださいcustomerActionTemplates[1].patterns)を文頭に付けて最初の1件を返します。アクションテンプレート、紐付け先設定の順に検査しますArray of objects (CustomerActionTemplateUpdateParam) 取引先アクションテンプレート一覧。省略・空配列の場合は変更なし。送った要素だけが変わります | |
Array of objects アクション詳細項目紐付け先設定一覧。省略・空配列の場合は変更なし。送った項目キー(itemKey)とアクション種別(pattern)の組み合わせだけが変わります |
{- "customerActionTemplates": [
- {
- "id": 12,
- "name": "初回訪問(改)"
}, - {
- "id": 13,
- "patterns": [
- 1,
- 3
]
}, - {
- "id": 14,
- "deleted": true
}, - {
- "name": "フォローの電話",
- "actionData": "確認すること:",
- "actionPoint": null,
- "patterns": [
- 3
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "visit_purpose",
- "pattern": 1,
- "visible": true,
- "required": true
}, - {
- "itemKey": "visit_purpose",
- "pattern": 2,
- "visible": false,
- "required": false
}
]
}{- "customerActionTemplates": [
- {
- "id": 0,
- "name": "string",
- "actionData": "string",
- "actionPoint": "string",
- "patterns": [
- 1
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "string",
- "pattern": 1,
- "visible": true,
- "required": true
}
]
}案件タイプ1つの案件アクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を取得します。
data などで包まず、設定のオブジェクトをそのまま返します。全件を1回で返し、ページングはありませんactionTemplates)は、アクションの入力画面でテンプレートを選ぶと事前メモ(preNote)・実施結果(result)に差し込まれる文章です。紐付くアクションの目的(purposeIds)のアクションで選べますGET /v2/deal_setting/deal_types/{id})の actionsPurposes で取得できますactionCustomItemScopeSettings)は、指定した案件タイプの案件アクションの入力画面でのアクション詳細項目の表示・必須です。アクションの登録・更新 API では検査されませんGET /v2/action_setting)のアクション詳細項目と同じで、項目ごとにアクション種別の昇順です。一度も設定していない組み合わせは、表示・必須とも false になります。後から追加した案件タイプでは、既存のアクション詳細項目は表示・必須とも false ですitemKey)で指します。項目名・項目タイプ・選択肢はアクション設定(GET /v2/action_setting)で取得できますPATCH /v2/action_setting/deal_action_settings/{deal_type_id})に送れます。別の案件タイプへ送るときは、アクションテンプレートの id を外し、目的の ID を種別と名前が同じ送り先の案件タイプの目的の ID に置き換えます| deal_type_id required | integer 案件タイプID |
{- "actionTemplates": [
- {
- "id": 0,
- "name": "string",
- "actionData": "string",
- "actionPoint": "string",
- "purposeIds": [
- 0
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "string",
- "pattern": 1,
- "visible": true,
- "required": true
}
]
}案件タイプ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)の空文字は空文字のまま保存されますitemKey)とアクション種別(pattern)の組み合わせで指定し、送った組み合わせだけが変わります。項目キーはアクション設定(GET /v2/action_setting)で取得できますvisible: false)組み合わせは必須(required: true)にできませんid の無い要素(追加)を含むリクエストを送り直すと、同じテンプレートがもう1件追加されます。通信の失敗などで送り直すときは、先に取得して追加済みかを確かめてくださいactionTemplates[1].purposeIds)を文頭に付けて最初の1件を返します。アクションテンプレート、紐付け先設定の順に検査します案件タイプを複製したときに、テンプレートも写す手順は次のとおりです。
GET /v2/action_setting/deal_action_settings/{deal_type_id})を取得するid を外すpurposeIds を、種別と名前が同じ複製先の目的の ID に置き換える| deal_type_id required | integer 案件タイプID |
Array of objects (DealActionTemplateUpdateParam) アクションテンプレート一覧。省略・空配列の場合は変更なし。送った要素だけが変わります | |
Array of objects アクション詳細項目紐付け先設定一覧。省略・空配列の場合は変更なし。送った項目キー(itemKey)とアクション種別(pattern)の組み合わせだけが変わります |
{- "actionTemplates": [
- {
- "id": 31,
- "purposeIds": [
- 101,
- 103
]
}, - {
- "name": "提案後のフォロー",
- "actionData": "",
- "actionPoint": "次回の約束:",
- "purposeIds": [
- 103
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "visit_purpose",
- "pattern": 1,
- "visible": true,
- "required": false
}
]
}{- "actionTemplates": [
- {
- "id": 0,
- "name": "string",
- "actionData": "string",
- "actionPoint": "string",
- "purposeIds": [
- 0
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "string",
- "pattern": 1,
- "visible": true,
- "required": true
}
]
}コンタクトアクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を取得します。
data などで包まず、設定のオブジェクトをそのまま返します。全件を1回で返し、ページングはありませんPATCH /v2/action_setting/contact_action_setting)に送れますcontactActionTemplates)は、アクションの入力画面でテンプレートを選ぶと事前メモ(preNote)・実施結果(result)に差し込まれる文章です。紐付くアクション種別(patterns)のアクションで選べますactionCustomItemScopeSettings)は、コンタクトアクションの入力画面でのアクション詳細項目の表示・必須です。アクションの登録・更新 API では検査されませんGET /v2/action_setting)のアクション詳細項目と同じで、項目ごとにアクション種別の昇順です。一度も設定していない組み合わせは、表示・必須とも false になりますitemKey)で指します。項目名・項目タイプ・選択肢はアクション設定(GET /v2/action_setting)で取得できますGET /v2/action_setting/customer_action_setting)で取得できます{- "contactActionTemplates": [
- {
- "id": 0,
- "name": "string",
- "actionData": "string",
- "actionPoint": "string",
- "patterns": [
- 1
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "string",
- "pattern": 1,
- "visible": true,
- "required": true
}
]
}コンタクトアクションのアクションテンプレートと、アクション詳細項目の紐付け先設定を更新します。
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)の空文字は空文字のまま保存されますitemKey)とアクション種別(pattern)の組み合わせで指定し、送った組み合わせだけが変わります。項目キーはアクション設定(GET /v2/action_setting)で取得できますvisible: false)組み合わせは必須(required: true)にできませんid の無い要素(追加)を含むリクエストを送り直すと、同じテンプレートがもう1件追加されます。通信の失敗などで送り直すときは、先に取得して追加済みかを確かめてくださいcontactActionTemplates[1].patterns)を文頭に付けて最初の1件を返します。アクションテンプレート、紐付け先設定の順に検査しますArray of objects (ContactActionTemplateUpdateParam) コンタクトアクションテンプレート一覧。省略・空配列の場合は変更なし。送った要素だけが変わります | |
Array of objects アクション詳細項目紐付け先設定一覧。省略・空配列の場合は変更なし。送った項目キー(itemKey)とアクション種別(pattern)の組み合わせだけが変わります |
{- "contactActionTemplates": [
- {
- "id": 21,
- "name": "名刺交換後フォロー(改)"
}, - {
- "id": 22,
- "patterns": [
- 2,
- 3
]
}, - {
- "id": 23,
- "deleted": true
}, - {
- "name": "セミナー後の電話",
- "actionData": "",
- "actionPoint": "次回の約束:",
- "patterns": [
- 3
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "visit_purpose",
- "pattern": 3,
- "visible": true,
- "required": true
}
]
}{- "contactActionTemplates": [
- {
- "id": 0,
- "name": "string",
- "actionData": "string",
- "actionPoint": "string",
- "patterns": [
- 1
]
}
], - "actionCustomItemScopeSettings": [
- {
- "itemKey": "string",
- "pattern": 1,
- "visible": true,
- "required": true
}
]
}アクション詳細項目を登録します。
項目タイプ(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)を省略すると、取引先・コンタクト・登録時点の全案件タイプのアクションで、全アクション種別に表示されます。項目を追加する前に、どの登録先・アクション種別で使うかを決めて指定してくださいGET /v2/deal_setting/deal_types)で調べます。別の環境へ移すときは、移行先の案件タイプIDに置き換えてください詳細項目の登録上限数を超えています(上限数: 30))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)で変更できます| name required | string <= 255 characters 項目名(255文字以内)。ドメイン内で一意。前後の空白(全角を含む)は除いて保存されます |
| itemKey | string <= 255 characters 項目キー(半角英数字と |
| itemType required | string Enum: "text" "date" "single_select" "multi_select" "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 になります
|
Array of objects or null (ActionCustomItemScopeSettingInput) アクション詳細項目紐付け先設定。登録先(取引先・案件タイプごとの案件・コンタクト)とアクション種別の組み合わせごとに、入力画面での表示・必須を指定します。 指定した組み合わせだけが指定どおりになり、指定しなかった組み合わせは表示されません(空配列ではどこにも表示されません)。 ただし、PAT の場合、実行ユーザーにアクションの参照権限が無い案件タイプの組み合わせは、指定しなくても「表示する・必須にしない」で作られます。 省略・null の場合は、取引先・コンタクト・登録時点の全案件タイプの全アクション種別で「表示する・必須にしない」になります |
{- "name": "訪問メモ",
- "itemKey": "visit_memo",
- "itemType": "text"
}{- "id": 101,
- "name": "商談の温度感",
- "itemType": "single_select",
- "itemKey": "temperature",
- "uiMode": 1,
- "actionCustomItemOptions": [
- {
- "id": 501,
- "value": 1,
- "label": "高"
}, - {
- "id": 502,
- "value": 2,
- "label": "中"
}, - {
- "id": 503,
- "value": 503,
- "label": "低"
}
]
}アクション詳細項目を更新します。
送ったキーだけが変わります。操作ごとのリクエストの例を載せています。
| したいこと | 送り方 |
|---|---|
| 項目名を変える | 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)に数値を送ると、文字列にして保存されますvalue で特定できません。取得結果をそのまま送ると、新しい選択肢の追加として扱われて400になるため、その項目では選択肢を送らずに更新してくださいuiMode)は単一選択・複数選択の項目だけが対象です。ほかの項目タイプに送っても読まれませんbefore に、手前に置く項目の項目キーを指定します。並び順は取引先・案件・コンタクトの全登録先、全アクション種別で共通です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})で行いますid・itemKey・itemType・選択肢の id)は無視されますdata などで包まず、更新したアクション詳細項目をそのまま返します。形はアクション設定の取得(GET /v2/action_setting)の要素と同じです| item_key required | string 項目キー |
| name | string <= 255 characters 項目名(255文字以内)。ドメイン内で一意。前後の空白(全角を含む)は除いて保存されます |
| newItemKey | string <= 255 characters 新しい項目キー(半角英数字と |
Array of objects (ActionCustomItemOptionUpdateParam) 選択肢の一覧。送った選択肢は、送った順に並びます。送らなかった選択肢は今の位置のまま残ります。全部の並びを決めるときは、全部の選択肢を送ってください | |
| uiMode | integer or null 表示形式。itemType が single_select の時は 1・2、multi_select の時は 1・3 を指定できます。 省略した場合は変更されません。設定済みの表示形式を null にすることはできません。その他の itemType では読まれません
|
| before | string or null 指定した項目キーの手前に項目を移動します。省略した場合は位置を変更せず、null・空文字の場合は末尾に移動します |
{- "name": "商談の温度感(改)",
- "newItemKey": "deal_temperature",
- "uiMode": 2,
- "before": null,
- "actionCustomItemOptions": [
- {
- "value": 1,
- "label": "とても高い"
}
]
}{- "id": 0,
- "name": "string",
- "itemType": "text",
- "itemKey": "string",
- "uiMode": 0,
- "actionCustomItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}アクション詳細項目を削除します。
| item_key required | string 項目キー |
{- "error": "The access token is invalid."
}ラベル型のアクション詳細項目に登録されているラベルの一覧を取得します。
404 を返しますpage / limit によるページングに対応しています| actionCustomItemKey required | string アクション詳細項目の項目キー |
| searchWord | string 指定した文字列と部分一致するラベルを検索します。 |
| sort | string 並び順。 |
| page | integer ページ番号(1始まり)。未指定時は1ページ目 |
| limit | integer 取得件数(1〜1000、デフォルト100) |
{- "actionCustomItemKey": "string",
- "totalCount": 0,
- "page": 0,
- "labels": [
- {
- "id": 0,
- "name": "string",
- "createdAt": "2018-04-01T10:30:00+09:00"
}
]
}取引先一覧をカーソルページネーション形式で取得します。
customers キー ({ customers, hasMore, nextCursor, totalCount })GET /api/v1/customers と互換のあるデータを、v2 形式で提供します| limit | integer [ 1 .. 1000 ] Default: 100 取得件数(1〜1000、デフォルト100) |
| cursor | string 次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る |
| searchWord | string 指定した文字列と取引先名が部分一致する取引先を検索します。 |
| updatedAtFrom | string <date-time> 更新日時による検索範囲(開始)
|
| updatedAtTo | string <date-time> 更新日時による検索範囲(終了)
|
| sort | string Default: "-updated_at" Enum: "updated_at" "-updated_at" "created_at" "-created_at" "updatedAt" "-updatedAt" "createdAt" "-createdAt" 並び順
ソート可能 |
| itemKeyAsPropertyKey | string Enum: "true" "false" true の場合、customerCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します |
{- "customers": [
- {
- "id": 0,
- "name": "string",
- "companyNum": "string",
- "establishYear": 0,
- "industry": {
- "id": 0,
- "name": "string"
}, - "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "closingMonth": 0,
- "capital": 0,
- "company": {
- "name": "string",
- "companyNum": "string"
}, - "ownerRole": {
- "id": 0,
- "name": "string"
}, - "customerCustoms": [
- {
- "id": 0,
- "customerCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}
], - "hasMore": true,
- "nextCursor": "string",
- "totalCount": 0
}取引先を登録します。
| 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に対応する業種名がレスポンスの |
| ownerRoleId | integer or null 所有ロールID |
| parentId | integer or null 親取引先ID |
| companyNum | string or null 取引先の基本項目「法人番号」。13桁の半角数字で指定します(形式が不正な場合は 400 になります)。 |
Array of objects (CustomerCustomCreateParam) 取引先詳細項目。項目は customerCustomItemId か itemKey で特定する | |
Array of objects (CustomObjectAssociationParam) 関連付けカスタムオブジェクト |
{- "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": [
- {
- "customerCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
], - "customObjects": [
- {
- "id": 0,
- "delete": true
}
]
}{- "id": 0,
- "name": "string",
- "companyNum": "string",
- "establishYear": 0,
- "industry": {
- "id": 0,
- "name": "string"
}, - "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "capital": 0,
- "company": {
- "name": "string",
- "companyNum": "string"
}, - "closingMonth": 0,
- "ownerRole": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "customerCustoms": [
- {
- "id": 0,
- "customerCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
]
}取引先情報を検索します。v1 POST /api/v1/customers/search と同形式の compositeFilter を受け付けます。
page に代えてカーソル形式 (limit / cursor / nextCursor / hasMore)。totalCount は維持customers(v1 互換)filter: id / name / address / telNo / memo / webUrl / industryId / capital / employee / establishYear / closingMonth / ownerRoleId / createdAt / updatedAtsort: 上記のうち webUrl を除いたもの。省略時は updatedAt 降順(id 昇順タイブレーク)companyNum は filter / sort に指定できません(指定すると 400 になります)required | object (CustomerSearchFilter) 絞り込み条件
|
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項目キー)をプロパティ名にしたオブジェクトで返します |
{- "filter": {
- "compositeFilter": {
- "logicalOperator": "AND",
- "subFilters": [
- {
- "compositeFilter": { },
- "valueFilter": {
- "field": {
- "name": "name",
- "customItemId": 0,
- "itemKey": "string"
}, - "comparisonOperator": "=",
- "value": {
- "stringValue": "string",
- "integerValue": 0,
- "decimalValue": 0.1,
- "datetimeValue": "2018-04-01T10:30:00+09:00"
}
}
}
]
}
}, - "sort": {
- "field": {
- "name": "updatedAt"
}, - "order": "ASC"
}, - "limit": 100,
- "cursor": "string",
- "itemKeyAsPropertyKey": "true"
}{- "totalCount": 0,
- "nextCursor": "string",
- "hasMore": true,
- "customers": [
- {
- "id": 0,
- "name": "string",
- "companyNum": "string",
- "establishYear": 0,
- "industry": {
- "id": 0,
- "name": "string"
}, - "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "closingMonth": 0,
- "capital": 0,
- "company": {
- "name": "string",
- "companyNum": "string"
}, - "ownerRole": {
- "id": 0,
- "name": "string"
}, - "customerCustoms": [
- {
- "id": 0,
- "customerCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}
]
}取引先情報を取得します。
include_related_objects=1 を指定するとカスタムオブジェクト連携情報(customObjects)を含みます| id required | integer 取引先ID |
| itemKeyAsPropertyKey | string Enum: "true" "false" true の場合、customerCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します |
| include_related_objects | integer Default: 0
|
{- "id": 0,
- "name": "string",
- "companyNum": "string",
- "establishYear": 0,
- "industry": {
- "id": 0,
- "name": "string"
}, - "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "closingMonth": 0,
- "capital": 0,
- "company": {
- "name": "string",
- "companyNum": "string"
}, - "ownerRole": {
- "id": 0,
- "name": "string"
}, - "customerCustoms": [
- {
- "id": 0,
- "customerCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "customObjects": [
- {
- "id": 0,
- "customObjectDefKey": "string"
}
], - "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 や空文字を指定しても既存値は削除されません。| id required | integer 取引先ID |
| 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 設立年(西暦)。 |
| industryId | integer or null 業種ID。指定したIDに対応する業種名がレスポンスの |
object or null 業種。 | |
| ownerRoleId | integer or null 所有ロールID |
| companyNum | string or null 取引先の基本項目「法人番号」。13桁の半角数字で指定します(形式が不正な場合は 400 になります)。 |
Array of objects 取引先詳細項目 |
{- "name": "string",
- "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "capital": 0,
- "closingMonth": 0,
- "establishYear": 0,
- "industryId": 0,
- "industry": {
- "id": 0
}, - "ownerRoleId": 0,
- "companyNum": "string",
- "customerCustoms": [
- {
- "id": 0,
- "customerCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
]
}{- "id": 0,
- "name": "string",
- "companyNum": "string",
- "establishYear": 0,
- "industry": {
- "id": 0,
- "name": "string"
}, - "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "capital": 0,
- "company": {
- "name": "string",
- "companyNum": "string"
}, - "closingMonth": 0,
- "ownerRole": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "customerCustoms": [
- {
- "id": 0,
- "customerCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "customerCustomItemOptionId": 0,
- "value": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
]
}取引先を一括登録します(v1同様の同期実行)。
required | Array of objects (CustomerBulkCreateItem) <= 1000 items 登録する取引先の配列 |
{- "customers": [
- {
- "name": "string",
- "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "capital": 0,
- "closingMonth": 1,
- "establishYear": 0,
- "industryId": 0,
- "ownerRoleId": 0,
- "companyNum": "string",
- "customerCustoms": [
- {
- "customerCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
]
}
]
}[- 0
]取引先を一括更新します(v1同様の同期実行)。
required | Array of objects (CustomerBulkUpdateItem) <= 1000 items 更新する取引先の配列 |
{- "customers": [
- {
- "id": 0,
- "name": "string",
- "address": "string",
- "telNo": "string",
- "webUrl": "string",
- "employee": 0,
- "capital": 0,
- "closingMonth": 1,
- "establishYear": 0,
- "industryId": 0,
- "ownerRoleId": 0,
- "companyNum": "string",
- "customerCustoms": [
- {
- "customerCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
]
}
]
}[- 0
]指定した取引先に紐づくアクション一覧をカーソルページネーション形式で取得します。
{ totalCount, nextCursor, hasMore, actions })。v1 の page はカーソルページネーションに置き換えcustomer_id に all を指定すると全取引先のアクションを対象とする取引先アクション参照 権限が無い場合は 403 ではなく 200 + 空配列を返すrequired | integer or string 取引先IDを指定してアクションを検索します。 取引先IDの代わりに、allと指定することで取引先IDを跨いだアクションの取得が可能です。 |
| 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 | string <date-time> Example: startDatetime=2018-04-01T10:30:00+09:00 開始日時 ex)
上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00(JST)のアクションを検索します。 日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: |
| endDatetime | string <date-time> Example: endDatetime=2018-04-01T10:30:00+09:00 終了日時 ex)
上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00(JST)のアクションを検索します。 日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: |
| createdAtFrom | string <date-time> Example: createdAtFrom=2018-04-01T10:30:00+09:00 登録日時開始時間 ex)
上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。 日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: |
| createdAtTo | string <date-time> Example: createdAtTo=2018-04-01T10:30:00+09:00 登録日時終了時間 ex)
上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。 日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: |
| updatedAtFrom | string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00+09:00 最終更新日時開始時間 ex)
上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。 日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: |
| updatedAtTo | string <date-time> Example: updatedAtTo=2018-04-01T10:30:00+09:00 最終更新日時終了時間 ex)
上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00(JST)のアクションを検索します。 日時は ISO 8601 形式でタイムゾーンを明示して指定してください(UTC: |
| users[][id] | Array of integers アクション担当者、その他の担当者を検索します。 GETパラメータで指定する場合、以下の形式で指定します。
|
| pattern | integer アクションの種別 |
| active | string Enum: "true" "false" true:予定 false:完了 |
{- "totalCount": 0,
- "nextCursor": "string",
- "hasMore": true,
- "actions": [
- {
- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "customer": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "text",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "A",
- "B",
- "C"
]
}
]
}
]
}取引先アクションを新規登録します。
pattern、startDatetime、endDatetime、creator は必須| customer_id required | integer 取引先ID |
| skipNotice | string Enum: "true" "false"
|
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 アクション詳細項目一覧 |
{- "pattern": {
- "id": 0
}, - "startDatetime": "2019-08-24T14:15:22Z",
- "endDatetime": "2019-08-24T14:15:22Z",
- "creator": {
- "id": 0
}, - "invitees": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
], - "preNote": "string",
- "result": "string",
- "active": true,
- "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "customer": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "text",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "A",
- "B",
- "C"
]
}
]
}| customer_id required | integer 取引先ID |
| id required | integer アクションID |
| include_files | integer
|
{- "files": [
- {
- "name": "string",
- "mimeType": "string",
- "url": "string"
}
], - "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "customer": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "text",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "A",
- "B",
- "C"
]
}
]
}取引先アクションを更新します。
invitees を指定した場合は全量置き換えになります| customer_id required | integer 取引先ID |
| id required | integer アクションID |
| skipNotice | string Enum: "true" "false"
|
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 アクション詳細項目一覧 |
{- "pattern": {
- "id": 0
}, - "startDatetime": "2019-08-24T14:15:22Z",
- "endDatetime": "2019-08-24T14:15:22Z",
- "creator": {
- "id": 0
}, - "preNote": "string",
- "result": "string",
- "active": true,
- "invitees": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
], - "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "customer": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "A",
- "B",
- "C"
]
}
]
}| customer_id required | integer 取引先ID |
| id required | integer アクションID |
| skipNotice | string Enum: "true" "false"
|
{- "error": "The access token is invalid."
}取引先アクションを一括登録します。
| skipNotice | string Enum: "true" "false"
|
required | Array of objects |
{- "actions": [
- {
- "customer": {
- "id": 0
}, - "pattern": {
- "id": 0
}, - "startDatetime": "2018-04-01T10:30:00+09:00",
- "endDatetime": "2018-04-01T10:30:00+09:00",
- "creator": {
- "id": 0
}, - "invitees": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
], - "preNote": "string",
- "result": "string",
- "active": true,
- "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
], - "files": [
- {
- "name": "string",
- "path": "string"
}
]
}
]
}[- 0
]案件タイプを、フェーズ・商品・契約確度・チャネル・最終・停止フェーズ理由・アクション目的・取引先タイプ・カラーラベルと、 基本項目の説明と合わせて登録します。
<場所>: <理由> の形で最初の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件 |
複製の手順
{"dealCustomItemGroupId": 直前に作ったグループの id})、複製元と同じ並びになります| 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 基本項目設定。指定しない項目は説明なし |
{- "name": "新規営業",
- "enableContractAccuracy": true,
- "phases": [
- {
- "name": "初回訪問",
- "status": 1
}, - {
- "name": "提案",
- "status": 1,
- "description": "提案書を送った段階"
}, - {
- "name": "受注",
- "status": 2
}, - {
- "name": "失注",
- "status": 3
}
], - "products": [
- {
- "name": "商品A",
- "description": "主力商品"
}, - {
- "name": "商品B"
}
], - "probabilities": [
- {
- "nameWithoutPercentage": "A",
- "percentage": 80
}, - {
- "nameWithoutPercentage": "B",
- "percentage": 50
}
], - "channels": [
- {
- "name": "紹介"
}
], - "endPhaseReasons": [
- {
- "name": "予算不足"
}
], - "dealBasicFieldSettings": [
- {
- "field": "amount",
- "description": "税抜の金額を入力します"
}
]
}{- "id": 0,
- "name": "string",
- "phases": [
- {
- "id": 0,
- "name": "string",
- "status": 0,
- "description": "string",
- "orderNum": 0
}
], - "products": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "orderNum": 0
}
], - "probabilities": [
- {
- "id": 0,
- "name": "string",
- "nameWithoutPercentage": "string",
- "percentage": 100,
- "description": "string",
- "orderNum": 0
}
], - "channels": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "orderNum": 0
}
], - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "actionsPurposes": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0,
- "pattern": 0,
- "patternName": "string"
}
], - "dealCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "orderNum": 0,
- "itemType": "text",
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string",
- "description": "string"
}
], - "description": "string"
}
], - "dealRequiredFields": [
- {
- "phaseId": 0,
- "amount": true,
- "dealProductDetail": true,
- "dealCustomItemIds": [
- 0
]
}
], - "dealCustomerTypes": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "enableContractAccuracy": true,
- "enableDealProductDetailUnitCost": true,
- "dealSearchActionRanges": [
- {
- "id": 0,
- "name": "string",
- "minDays": 0,
- "maxDays": 0,
- "colorCode": "string",
- "orderNum": 0
}
], - "dealBasicFieldSettings": [
- {
- "field": "name",
- "description": "string"
}
], - "proposalTypes": [
- {
- "id": 0,
- "name": "string"
}
]
}案件タイプに紐づく設定情報(フェーズ・商品・契約確度・チャネル・最終・停止フェーズ理由・アクション目的・ 案件詳細項目・フェーズ毎の必須項目・取引先タイプ・カラーラベル・基本項目設定・利用する提案タイプ)と、 確度掛け機能・原価表示の有効/無効を取得します。
{"dealType": …} のように包まず、案件タイプ設定情報のオブジェクトをそのまま返します| id required | integer 案件タイプID |
{- "id": 0,
- "name": "string",
- "phases": [
- {
- "id": 0,
- "name": "string",
- "status": 0,
- "description": "string",
- "orderNum": 0
}
], - "products": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "orderNum": 0
}
], - "probabilities": [
- {
- "id": 0,
- "name": "string",
- "nameWithoutPercentage": "string",
- "percentage": 100,
- "description": "string",
- "orderNum": 0
}
], - "channels": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "orderNum": 0
}
], - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "actionsPurposes": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0,
- "pattern": 0,
- "patternName": "string"
}
], - "dealCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "orderNum": 0,
- "itemType": "text",
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string",
- "description": "string"
}
], - "description": "string"
}
], - "dealRequiredFields": [
- {
- "phaseId": 0,
- "amount": true,
- "dealProductDetail": true,
- "dealCustomItemIds": [
- 0
]
}
], - "dealCustomerTypes": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "enableContractAccuracy": true,
- "enableDealProductDetailUnitCost": true,
- "dealSearchActionRanges": [
- {
- "id": 0,
- "name": "string",
- "minDays": 0,
- "maxDays": 0,
- "colorCode": "string",
- "orderNum": 0
}
], - "dealBasicFieldSettings": [
- {
- "field": "name",
- "description": "string"
}
], - "proposalTypes": [
- {
- "id": 0,
- "name": "string"
}
]
}既存の案件タイプの設定を、送った設定・要素・キーだけ差分で更新します。
deleted: true を付けて指定します<場所>: <理由> の形で最初の1件だけが入ります(例: products[0].deleted: 削除する要素は id と一緒に指定してください)。場所の添字は0始まりで、送った配列の位置です。送っていない既存の要素の誤りは、probabilities[id=30].percentage のように添字の代わりに [id=<ID>] で表します。使用中で削除できない場合は、使用先を含む理由を返します送り方の例
リクエストの例(Request samples)は、次のように更新します。
並び順(orderNum)
| 一覧 | 新しい要素で orderNum を省略・null | orderNum を指定(新しい要素・既存の要素) |
|---|---|---|
| phases | 同じ状態の先頭に入り、後ろの要素の並び順が追加した件数ぶんずれる | 送った値をそのまま保存する。他の要素の並び順は変わらない |
| actionsPurposes | 末尾に入る | 同上 |
| products・probabilities・channels・endPhaseReasons・dealCustomerTypes | 先頭に入り、後ろの要素の並び順が追加した件数ぶんずれる | 同上 |
並べ替えるときは、並べ替える一覧の全要素に、重ならない orderNum を付けて送ります。フェーズは、状態(進行中・受注・失注)の順に並ぶ値にします。
| id required | integer 案件タイプID |
| 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 の場合は変更なし。提案機能が無効なドメインでは変更できません |
{- "products": [
- {
- "id": 31,
- "name": "商品A(改)"
}, - {
- "name": "商品C",
- "description": "新商品"
}, - {
- "id": 32,
- "deleted": true
}
], - "dealRequiredFields": [
- {
- "phaseId": 51,
- "amount": true,
- "dealCustomItemIds": [
- 201,
- 205
]
}
], - "proposalTypes": [
- {
- "id": 3
}, - {
- "id": 1
}
]
}{- "id": 0,
- "name": "string",
- "phases": [
- {
- "id": 0,
- "name": "string",
- "status": 0,
- "description": "string",
- "orderNum": 0
}
], - "products": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "orderNum": 0
}
], - "probabilities": [
- {
- "id": 0,
- "name": "string",
- "nameWithoutPercentage": "string",
- "percentage": 100,
- "description": "string",
- "orderNum": 0
}
], - "channels": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "orderNum": 0
}
], - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "actionsPurposes": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0,
- "pattern": 0,
- "patternName": "string"
}
], - "dealCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "orderNum": 0,
- "itemType": "text",
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string",
- "description": "string"
}
], - "description": "string"
}
], - "dealRequiredFields": [
- {
- "phaseId": 0,
- "amount": true,
- "dealProductDetail": true,
- "dealCustomItemIds": [
- 0
]
}
], - "dealCustomerTypes": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "enableContractAccuracy": true,
- "enableDealProductDetailUnitCost": true,
- "dealSearchActionRanges": [
- {
- "id": 0,
- "name": "string",
- "minDays": 0,
- "maxDays": 0,
- "colorCode": "string",
- "orderNum": 0
}
], - "dealBasicFieldSettings": [
- {
- "field": "name",
- "description": "string"
}
], - "proposalTypes": [
- {
- "id": 0,
- "name": "string"
}
]
}案件タイプを1件削除します。画面から削除したときと同じ条件で判定し、同じ処理を行います。
| id required | integer 案件タイプID |
{- "error": "Bad Request",
- "messages": [
- "string"
]
}案件タイプに設定された案件詳細項目と案件詳細項目グループを、設定画面と同じ並びで取得します。
| deal_type_id required | integer 案件タイプID |
{- "layout": [
- {
- "dealCustomItem": {
- "id": 101,
- "itemKey": null,
- "name": "予算メモ",
- "itemType": "text",
- "uiMode": null,
- "description": null,
- "dealCustomItemGroupId": null,
- "customItemOptions": [ ],
- "logicalFormula": null,
- "dealCustomItemCalculations": null
}, - "dealCustomItemGroup": null
}, - {
- "dealCustomItem": null,
- "dealCustomItemGroup": {
- "id": 11,
- "name": "契約情報",
- "dealCustomItems": [
- {
- "id": 201,
- "itemKey": "lead_source",
- "name": "流入経路",
- "itemType": "single_select",
- "uiMode": 2,
- "description": null,
- "dealCustomItemGroupId": 11,
- "customItemOptions": [
- {
- "id": 301,
- "value": 1,
- "label": "展示会",
- "description": "春・秋の展示会"
}, - {
- "id": 302,
- "value": 2,
- "label": "Web問い合わせ",
- "description": null
}
], - "logicalFormula": null,
- "dealCustomItemCalculations": null
}
]
}
}
]
}案件タイプに案件詳細項目を1件、選択肢・式と合わせて登録します。
<場所>: <理由> の形で最初の1件だけが入ります(例: customItemOptions[1].label: 値を指定してください)。場所の添字は0始まりで、送った配列の位置です型ごとの送り方
型ごとの例は、リクエストの例(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つの部品の間にだけ置けます。
複製の手順
別の案件タイプ・環境へ同じ並びで複製する手順は次のとおりです。複製先の案件タイプに案件詳細項目・案件詳細項目グループが無い場合に、複製元と同じ並びになります。
{"dealCustomItemGroupId": 直前に作ったグループの id}){"dealCustomItemGroupId": グループの登録のレスポンスの id})も指定できます。先に作った案件詳細項目は {"dealCustomItemId": 本APIのレスポンスの id} で指定します。後ろに作成済みの要素が無いときは before を省略します(入れる先の末尾に入ります)| deal_type_id required | integer 案件タイプID |
| 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" 案件詳細項目タイプ。以下のいずれかを指定します。
|
| 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 のときは画面で作成したときと同じ値
|
| 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部品。参照先は契約金額か数値・数値(小数点あり)の案件詳細項目 |
{- "name": "予算メモ",
- "itemType": "text",
- "itemKey": "budget_memo",
- "description": "予算の補足を書きます"
}{- "id": 203,
- "itemKey": "lead_source",
- "name": "流入経路",
- "itemType": "single_select",
- "uiMode": 2,
- "description": null,
- "dealCustomItemGroupId": null,
- "customItemOptions": [
- {
- "id": 301,
- "value": 1,
- "label": "展示会",
- "description": "春・秋の展示会"
}, - {
- "id": 302,
- "value": 2,
- "label": "Web問い合わせ",
- "description": null
}
], - "logicalFormula": null,
- "dealCustomItemCalculations": null
}案件詳細項目を1件更新します。指定した項目だけを変更し、省略した項目は変更しません。
<場所>: <理由> の形で最初の1件だけが入ります(例: itemType: 変更できません(現在の値: single_select))。場所の添字は0始まりで、送った配列の位置です| deal_type_id required | integer 案件タイプID |
| id required | integer 案件詳細項目ID |
| 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 には変更できません
|
| 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部品 |
{- "name": "流入経路(改)",
- "customItemOptions": [
- {
- "id": 301,
- "label": "展示会(春)"
}, - {
- "label": "セミナー"
}, - {
- "id": 302,
- "deleted": true
}
]
}{- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "text",
- "uiMode": 0,
- "description": "string",
- "dealCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string",
- "description": "string"
}
], - "logicalFormula": [
- {
- "type": "item",
- "data": "string",
- "model": "string",
- "modelId": 0,
- "property": "string",
- "funcStart": true,
- "funcEnd": true
}
], - "dealCustomItemCalculations": [
- {
- "type": "item",
- "data": "string",
- "model": "string",
- "modelId": 0,
- "property": "string",
- "funcStart": true,
- "funcEnd": true
}
]
}案件詳細項目を1件削除します。削除は取り消せません。
| deal_type_id required | integer 案件タイプID |
| id required | integer 案件詳細項目ID |
{- "error": "Bad Request",
- "messages": [
- "string"
]
}案件タイプに、案件詳細項目の入っていない案件詳細項目グループを1件登録します。
<場所>: <理由> の形で最初の1件だけが入ります(例: before.dealCustomItemId: 対象の案件タイプに存在しないIDです)| deal_type_id required | integer 案件タイプID |
| name required | string [ 1 .. 100 ] characters 案件詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。同じ名前のグループも登録できます |
object = 1 properties 並び位置。グループに入っていない案件詳細項目か案件詳細項目グループの前に入り、後ろの要素は順にずれます。省略したときは先頭。null は指定できません |
{- "name": "契約情報",
- "before": {
- "dealCustomItemId": 102
}
}{- "id": 0,
- "name": "string",
- "dealCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "text",
- "uiMode": 0,
- "description": "string",
- "dealCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string",
- "description": "string"
}
], - "logicalFormula": [
- {
- "type": "item",
- "data": "string",
- "model": "string",
- "modelId": 0,
- "property": "string",
- "funcStart": true,
- "funcEnd": true
}
], - "dealCustomItemCalculations": [
- {
- "type": "item",
- "data": "string",
- "model": "string",
- "modelId": 0,
- "property": "string",
- "funcStart": true,
- "funcEnd": true
}
]
}
]
}案件タイプの案件詳細項目グループ1件の名前と並び位置を更新します。
<場所>: <理由> の形で最初の1件だけが入ります(例: before.dealCustomItemId: 対象の案件タイプに存在しないIDです)| deal_type_id required | integer 案件タイプID |
| id required | integer 案件詳細項目グループID |
| name | string [ 1 .. 100 ] characters 案件詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。null は指定できません |
object or null = 1 properties 並び位置。グループに入っていない案件詳細項目か他の案件詳細項目グループの前に、中の案件詳細項目ごと移り、他の要素は順にずれます。null のときは末尾。省略したときは変更しません |
{- "name": "string",
- "before": {
- "dealCustomItemId": 0
}
}{- "id": 0,
- "name": "string",
- "dealCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "text",
- "uiMode": 0,
- "description": "string",
- "dealCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string",
- "description": "string"
}
], - "logicalFormula": [
- {
- "type": "item",
- "data": "string",
- "model": "string",
- "modelId": 0,
- "property": "string",
- "funcStart": true,
- "funcEnd": true
}
], - "dealCustomItemCalculations": [
- {
- "type": "item",
- "data": "string",
- "model": "string",
- "modelId": 0,
- "property": "string",
- "funcStart": true,
- "funcEnd": true
}
]
}
]
}案件タイプの案件詳細項目グループ1件を削除します。
| deal_type_id required | integer 案件タイプID |
| id required | integer 案件詳細項目グループID |
{- "error": "The access token is invalid."
}商品内訳設定の一覧を取得します。
dealProductDetailTypes キー({ totalCount, page, dealProductDetailTypes })page / limit によるページ方式(limit のデフォルトは100、最大1000)dealProductDetailTypeCustom は詳細項目の itemKey(API項目キー)をプロパティ名にしたオブジェクトで、型に該当する値フィールドのみを返します| page | integer >= 1 Default: 1 ページ番号(1始まり)。未指定時は1ページ目 |
| limit | integer [ 1 .. 1000 ] Default: 100 取得件数(1〜1000、デフォルト100)。0以下の場合は100、1000を超える場合は1000として扱います |
| sort | string 並び順。キーの前に |
| dealTypeId | Array of integers 案件タイプID。未指定時はドメイン全ての商品内訳設定を取得します。指定時は指定案件タイプで利用可能な商品内訳設定を取得します。 |
{- "totalCount": 0,
- "page": 0,
- "dealProductDetailTypes": [
- {
- "id": 0,
- "name": "サクパケ",
- "dealTypeIds": [
- 0
], - "unit": "式",
- "price": "1000.0",
- "billingType": {
- "id": 0,
- "key": "string",
- "name": "string"
}, - "roundType": {
- "id": 0,
- "key": "string",
- "name": "string"
}, - "unitCostRoundType": {
- "id": 0,
- "key": "string",
- "name": "string"
}, - "memo": "string",
- "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "dealProductDetailTypeCustom": {
- "property1": {
- "id": 0,
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 1234.56,
- "selectedOption": {
- "id": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}, - "property2": {
- "id": 0,
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 1234.56,
- "selectedOption": {
- "id": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}
}
}
]
}商品内訳設定のカスタム項目(詳細項目)定義の一覧を取得します。
orderNum、id の昇順で返しますdealProductDetailTypeCustomItems(v2のレスポンスキーはすべて camelCase)dealProductDetailTypeCustomItemOptions)は itemType が single_select / multi_select の項目のみ返します| dealTypeId | Array of integers 案件タイプID。未指定時はドメイン全ての商品内訳設定カスタム項目を取得します。指定時は指定案件タイプで利用可能な商品内訳設定カスタム項目を取得します。 |
{- "dealProductDetailTypeCustomItems": [
- {
- "id": 0,
- "dealTypeIds": [
- 0
], - "name": "string",
- "itemType": "string",
- "orderNum": 0,
- "itemKey": "string",
- "dealProductDetailTypeCustomItemOptions": [
- {
- "id": 0,
- "label": "string"
}
]
}
]
}商品内訳設定を一括登録します(同期実行)。
value で渡し、項目タイプに応じた属性へ自動的に振り分けられますrequired | Array of objects (DealProductDetailTypeBulkCreateItem) <= 1000 items 登録する商品内訳設定の配列 |
{- "dealProductDetailTypes": [
- {
- "name": "サクパケ",
- "dealTypeIds": [
- 0
], - "price": 0,
- "unitCost": 0,
- "quantity": 0,
- "unit": "式",
- "billingTypeId": 0,
- "roundTypeId": 0,
- "unitCostRoundTypeId": 0,
- "grossProfitMargin": 0,
- "enableAutoCalculatePrice": true,
- "memo": "string",
- "dealProductDetailTypeCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "itemKey": "string",
- "value": null
}
]
}
]
}[- 0
]商品内訳設定を一括更新します(同期実行)。
required | Array of objects (DealProductDetailTypeBulkUpdateItem) <= 1000 items 更新する商品内訳設定の配列 |
{- "dealProductDetailTypes": [
- {
- "id": 0,
- "name": "サクパケ",
- "dealTypeIds": [
- 0
], - "price": 0,
- "unitCost": 0,
- "quantity": 0,
- "unit": "式",
- "grossProfitMargin": 0,
- "enableAutoCalculatePrice": true,
- "memo": "string",
- "dealProductDetailTypeCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "itemKey": "string",
- "value": null
}
]
}
]
}{- "error": "Bad Request",
- "messages": [
- "string"
]
}案件一覧をカーソルページネーション形式で取得します
deals キーの配列を含む構造 ({ deals, hasMore, nextCursor, totalCount })| limit | integer [ 1 .. 1000 ] Default: 100 取得件数(1〜1000、デフォルト100) |
| cursor | string 次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る |
| searchWord | string 指定した文字列と取引先名、または案件名が部分一致する案件を検索します。 |
| dealTypeId | integer 案件タイプID |
| sort | string 並び順。 |
| 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"
|
{- "deals": [
- {
- "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": {
- "id": 0,
- "name": "string"
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "phase": {
- "id": 0,
- "name": "string",
- "status": 0
}, - "product": {
- "id": 0,
- "name": "string"
}, - "probability": {
- "id": 0,
- "name": "string"
}, - "channel": {
- "id": 0,
- "name": "string"
}, - "user": {
- "id": 0,
- "name": "string"
}, - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "phaseStayDays": [
- {
- "id": 0,
- "name": "string",
- "stayDays": 0,
- "isCurrentPhase": true
}
], - "currentPhaseStayDays": 0,
- "dealProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "name": "string",
- "billingType": {
- "id": 0,
- "name": "string"
}, - "quantity": 0,
- "unit": "string",
- "price": 0,
- "unitCost": 0,
- "term": 0,
- "subtotal": 0,
- "subtotalCost": 0,
- "subtotalProfit": 0,
- "firstSales": "2018-04-01T00:00:00+09:00",
- "memo": "string",
- "dealProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}
}
}
], - "dealCustomerTypes": [
- {
- "dealCustomerType": {
- "id": 0,
- "name": "string"
}, - "customers": [
- {
- "id": 0,
- "name": "string"
}
]
}
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 0,
- "url": "string",
- "decimalNumber": "string",
- "calculationResult": 0,
- "selectedOption": {
- "label": "string",
- "dealCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}
], - "hasMore": true,
- "nextCursor": "string",
- "totalCount": 0
}案件を登録します。
{ "id": N } 形式で指定| skipNotice | string Enum: "true" "false"
|
| itemKeyAsPropertyKey | string Enum: "true" "false"
|
| 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) 関連付けカスタムオブジェクト |
{- "name": "string",
- "amount": 0,
- "expectedContractDate": "2019-08-24",
- "reason": "string",
- "customer": {
- "id": 0
}, - "dealType": {
- "id": 0
}, - "phase": {
- "id": 0
}, - "product": {
- "id": 0
}, - "probability": {
- "id": 0
}, - "channel": {
- "id": 0
}, - "user": {
- "id": 0
}, - "endPhaseReasonIds": [
- 0
], - "dealCustoms": [
- {
- "dealCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
], - "dealProductDetails": [
- {
- "dealProductDetailTypeId": 0,
- "price": 0,
- "quantity": 0,
- "term": 0,
- "firstSales": "2019-08-24",
- "memo": "string",
- "unitCost": 0,
- "dealProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "value": null,
- "dealProductDetailCustomDetails": [
- 0
]
}
]
}
], - "dealCustomers": [
- {
- "dealCustomerTypeId": 0,
- "customerId": 0
}
], - "customObjects": [
- {
- "id": 0,
- "delete": true
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "phase": {
- "id": 0,
- "name": "string",
- "status": 0
}, - "product": {
- "id": 0,
- "name": "string"
}, - "probability": {
- "id": 0,
- "name": "string"
}, - "channel": {
- "id": 0,
- "name": "string"
}, - "user": {
- "id": 0,
- "name": "string"
}, - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "phaseStayDays": [
- {
- "id": 0,
- "name": "string",
- "stayDays": 0,
- "isCurrentPhase": true
}
], - "currentPhaseStayDays": 0,
- "dealProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "name": "string",
- "billingType": {
- "id": 0,
- "name": "string"
}, - "quantity": 0,
- "unit": "string",
- "price": 0,
- "unitCost": 0,
- "term": 0,
- "subtotal": 0,
- "subtotalCost": 0,
- "subtotalProfit": 0,
- "firstSales": "2018-04-01T00:00:00+09:00",
- "memo": "string",
- "dealProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}
}
}
], - "dealCustomerTypes": [
- {
- "dealCustomerType": {
- "id": 0,
- "name": "string"
}, - "customers": [
- {
- "id": 0,
- "name": "string"
}
]
}
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 0,
- "url": "string",
- "decimalNumber": "string",
- "calculationResult": 0,
- "selectedOption": {
- "label": "string",
- "dealCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}案件情報を検索します。
{ deals, hasMore, nextCursor, totalCount })sort で指定できます(例: name / updated_at / created_at)。省略時は updated_at 降順(id 昇順タイブレーク)| limit | integer [ 1 .. 1000 ] Default: 100 取得件数(1〜1000、デフォルト100) |
| cursor | string 次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る |
required | object (DealSearchFilter) 絞り込み条件
|
object (DealSearchSort) 並び替え条件。省略時は updated_at 降順(id 昇順タイブレーク)。 項目値が未設定のものは、昇順では先頭・降順では末尾に並びます。 |
{- "filter": {
- "compositeFilter": {
- "logicalOperator": "AND",
- "subFilters": [
- {
- "compositeFilter": { },
- "valueFilter": {
- "field": {
- "name": "string",
- "customItemId": 0,
- "itemKey": "string"
}, - "comparisonOperator": "=",
- "value": {
- "stringValue": "string",
- "integerValue": 0,
- "decimalValue": 0.1,
- "datetimeValue": "2018-04-01T10:30:00+09:00"
}
}
}
]
}
}, - "sort": {
- "field": {
- "name": "updated_at"
}, - "order": "ASC"
}
}{- "deals": [
- {
- "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": {
- "id": 0,
- "name": "string"
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "phase": {
- "id": 0,
- "name": "string",
- "status": 0
}, - "product": {
- "id": 0,
- "name": "string"
}, - "probability": {
- "id": 0,
- "name": "string"
}, - "channel": {
- "id": 0,
- "name": "string"
}, - "user": {
- "id": 0,
- "name": "string"
}, - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "phaseStayDays": [
- {
- "id": 0,
- "name": "string",
- "stayDays": 0,
- "isCurrentPhase": true
}
], - "currentPhaseStayDays": 0,
- "dealProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "name": "string",
- "billingType": {
- "id": 0,
- "name": "string"
}, - "quantity": 0,
- "unit": "string",
- "price": 0,
- "unitCost": 0,
- "term": 0,
- "subtotal": 0,
- "subtotalCost": 0,
- "subtotalProfit": 0,
- "firstSales": "2018-04-01T00:00:00+09:00",
- "memo": "string",
- "dealProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}
}
}
], - "dealCustomerTypes": [
- {
- "dealCustomerType": {
- "id": 0,
- "name": "string"
}, - "customers": [
- {
- "id": 0,
- "name": "string"
}
]
}
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 0,
- "url": "string",
- "decimalNumber": "string",
- "calculationResult": 0,
- "selectedOption": {
- "label": "string",
- "dealCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}
], - "hasMore": true,
- "nextCursor": "string",
- "totalCount": 0
}案件詳細を取得します。
include_related_objects=1 を指定すると関連カスタムオブジェクト情報(customObjects)を含みます| id required | integer 案件ID |
| itemKeyAsPropertyKey | string Enum: "true" "false"
|
| include_related_objects | integer Default: 0
|
{- "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": {
- "id": 0,
- "name": "string"
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "phase": {
- "id": 0,
- "name": "string",
- "status": 0
}, - "product": {
- "id": 0,
- "name": "string"
}, - "probability": {
- "id": 0,
- "name": "string"
}, - "channel": {
- "id": 0,
- "name": "string"
}, - "user": {
- "id": 0,
- "name": "string"
}, - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "phaseStayDays": [
- {
- "id": 0,
- "name": "string",
- "stayDays": 0,
- "isCurrentPhase": true
}
], - "currentPhaseStayDays": 0,
- "dealProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "name": "string",
- "billingType": {
- "id": 0,
- "name": "string"
}, - "quantity": 0,
- "unit": "string",
- "price": 0,
- "unitCost": 0,
- "term": 0,
- "subtotal": 0,
- "subtotalCost": 0,
- "subtotalProfit": 0,
- "firstSales": "2018-04-01T00:00:00+09:00",
- "memo": "string",
- "dealProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}
}
}
], - "dealCustomerTypes": [
- {
- "dealCustomerType": {
- "id": 0,
- "name": "string"
}, - "customers": [
- {
- "id": 0,
- "name": "string"
}
]
}
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 0,
- "url": "string",
- "decimalNumber": "string",
- "calculationResult": 0,
- "selectedOption": {
- "label": "string",
- "dealCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}案件を部分更新(PATCH)します。
{ "id": N } 形式で指定| id required | integer 案件ID |
| skipNotice | string Enum: "true" "false"
|
| itemKeyAsPropertyKey | string Enum: "true" "false"
|
| 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) 関連付けカスタムオブジェクト |
{- "name": "string",
- "amount": 0,
- "expectedContractDate": "2019-08-24",
- "reason": "string",
- "customer": {
- "id": 0
}, - "phase": {
- "id": 0
}, - "product": {
- "id": 0
}, - "probability": {
- "id": 0
}, - "channel": {
- "id": 0
}, - "user": {
- "id": 0
}, - "endPhaseReasonIds": [
- 0
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
], - "dealProductDetails": [
- {
- "id": 0,
- "deleted": true,
- "dealProductDetailTypeId": 0,
- "price": 0,
- "quantity": 0,
- "term": 0,
- "firstSales": "2019-08-24",
- "memo": "string",
- "unitCost": 0,
- "dealProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "value": null,
- "dealProductDetailCustomDetails": [
- 0
]
}
]
}
], - "dealCustomers": [
- {
- "dealCustomerTypeId": 0,
- "customerId": 0,
- "delete": true
}
], - "customObjects": [
- {
- "id": 0,
- "delete": true
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "phase": {
- "id": 0,
- "name": "string",
- "status": 0
}, - "product": {
- "id": 0,
- "name": "string"
}, - "probability": {
- "id": 0,
- "name": "string"
}, - "channel": {
- "id": 0,
- "name": "string"
}, - "user": {
- "id": 0,
- "name": "string"
}, - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "phaseStayDays": [
- {
- "id": 0,
- "name": "string",
- "stayDays": 0,
- "isCurrentPhase": true
}
], - "currentPhaseStayDays": 0,
- "dealProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "name": "string",
- "billingType": {
- "id": 0,
- "name": "string"
}, - "quantity": 0,
- "unit": "string",
- "price": 0,
- "unitCost": 0,
- "term": 0,
- "subtotal": 0,
- "subtotalCost": 0,
- "subtotalProfit": 0,
- "firstSales": "2018-04-01T00:00:00+09:00",
- "memo": "string",
- "dealProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}
}
}
], - "dealCustomerTypes": [
- {
- "dealCustomerType": {
- "id": 0,
- "name": "string"
}, - "customers": [
- {
- "id": 0,
- "name": "string"
}
]
}
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 0,
- "url": "string",
- "decimalNumber": "string",
- "calculationResult": 0,
- "selectedOption": {
- "label": "string",
- "dealCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}案件を一括登録します(v1同様の同期実行)。
dealTypeId で指定します| dealTypeId required | integer 案件タイプID |
| skipNotice | string Enum: "true" "false"
|
required | Array of objects (DealBulkCreateItem) 登録する案件の配列(最大1000件) |
{- "deals": [
- {
- "name": "string",
- "amount": 0,
- "expectedContractDate": "2019-08-24",
- "reason": "string",
- "customer": {
- "id": 0
}, - "phase": {
- "id": 0
}, - "product": {
- "id": 0
}, - "probability": {
- "id": 0
}, - "channel": {
- "id": 0
}, - "user": {
- "id": 0
}, - "endPhaseReasonIds": [
- 0
], - "dealLimitedSharingUserIds": [
- 0
], - "dealCustoms": [
- {
- "dealCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
], - "dealProductDetails": [
- {
- "dealProductDetailTypeId": 0,
- "price": 0,
- "quantity": 0,
- "term": 0,
- "firstSales": "2019-08-24",
- "memo": "string",
- "unitCost": 0,
- "dealProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "value": null,
- "dealProductDetailCustomDetails": [
- 0
]
}
]
}
], - "dealCustomers": [
- {
- "dealCustomerTypeId": 0,
- "customerId": 0
}
]
}
]
}[- 0
]案件を一括更新します(v1同様の同期実行)。
dealTypeId で指定しますid で既存レコードを特定し、送信したフィールドのみ更新します(部分更新)deals)とスキップした案件(skippedDeals)を返しますskippedDeals に含まれます(PAT のみ対象・TAT はロック無視)| dealTypeId required | integer 案件タイプID |
| skipNotice | string Enum: "true" "false"
|
required | Array of objects (DealBulkUpdateItem) 更新する案件の配列(最大1000件) |
{- "deals": [
- {
- "id": 0,
- "name": "string",
- "amount": 0,
- "expectedContractDate": "2019-08-24",
- "reason": "string",
- "customer": {
- "id": 0
}, - "phase": {
- "id": 0
}, - "product": {
- "id": 0
}, - "probability": {
- "id": 0
}, - "channel": {
- "id": 0
}, - "user": {
- "id": 0
}, - "endPhaseReasonIds": [
- 0
], - "dealLimitedSharingUserIds": [
- 0
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "value": "string"
}
], - "dealProductDetails": [
- {
- "id": 0,
- "deleted": true,
- "dealProductDetailTypeId": 0,
- "price": 0,
- "quantity": 0,
- "term": 0,
- "firstSales": "2019-08-24",
- "memo": "string",
- "unitCost": 0,
- "dealProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "value": null,
- "dealProductDetailCustomDetails": [
- 0
]
}
]
}
], - "dealCustomers": [
- {
- "dealCustomerTypeId": 0,
- "customerId": 0,
- "delete": true
}
]
}
]
}{- "deals": [
- {
- "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": {
- "id": 0,
- "name": "string"
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "phase": {
- "id": 0,
- "name": "string",
- "status": 0
}, - "product": {
- "id": 0,
- "name": "string"
}, - "probability": {
- "id": 0,
- "name": "string"
}, - "channel": {
- "id": 0,
- "name": "string"
}, - "user": {
- "id": 0,
- "name": "string"
}, - "endPhaseReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "phaseStayDays": [
- {
- "id": 0,
- "name": "string",
- "stayDays": 0,
- "isCurrentPhase": true
}
], - "currentPhaseStayDays": 0,
- "dealProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "name": "string",
- "billingType": {
- "id": 0,
- "name": "string"
}, - "quantity": 0,
- "unit": "string",
- "price": 0,
- "unitCost": 0,
- "term": 0,
- "subtotal": 0,
- "subtotalCost": 0,
- "subtotalProfit": 0,
- "firstSales": "2018-04-01T00:00:00+09:00",
- "memo": "string",
- "dealProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "itemType": 1,
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "decimalNumber": 0,
- "selectedOption": {
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealProductDetailTypeCustomItemOptionId": 0
}
]
}
}
}
], - "dealCustomerTypes": [
- {
- "dealCustomerType": {
- "id": 0,
- "name": "string"
}, - "customers": [
- {
- "id": 0,
- "name": "string"
}
]
}
], - "dealCustoms": [
- {
- "id": 0,
- "dealCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "string",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 0,
- "url": "string",
- "decimalNumber": "string",
- "calculationResult": 0,
- "selectedOption": {
- "label": "string",
- "dealCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "dealCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}
], - "skippedDeals": [
- {
- "index": 0,
- "id": 0,
- "reason": "DEAL_LOCKED"
}
]
}指定した案件に紐づくコンタクト一覧をv1同様のページ方式で取得します。
contacts キー ({ contacts, totalCount, page })| deal_id required | integer 案件ID |
| page | integer >= 1 Default: 1 ページ番号(1始まり)。未指定時は1ページ目 |
{- "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "totalCount": 0,
- "page": 0
}指定した案件からコンタクトの紐付けを削除します。
| deal_id required | integer 案件ID |
| contact_id required | integer コンタクトID |
{- "error": "The access token is invalid."
}案件アクション一覧をカーソルページネーション形式で取得します。
actions キーの配列を含む構造({ actions, hasMore, nextCursor, totalCount })| 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 | 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を指定して検索します |
{- "actions": [
- {
- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "deal": {
- "id": 0,
- "name": "string"
}, - "purpose": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "proposals": [
- {
- "id": 0,
- "name": "string",
- "amount": 0,
- "proposalStatus": {
- "id": 0,
- "name": "string"
}
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "A",
- "B",
- "C"
]
}
]
}
], - "hasMore": true,
- "nextCursor": "string",
- "totalCount": 0
}案件アクションを新規登録します。
purpose、startDatetime、endDatetime、creator、deal は必須| skipNotice | string Enum: "true" "false"
|
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 アクション詳細項目一覧 |
{- "purpose": {
- "id": 0
}, - "startDatetime": "2019-08-24T14:15:22Z",
- "endDatetime": "2019-08-24T14:15:22Z",
- "creator": {
- "id": 0
}, - "deal": {
- "id": 0
}, - "invitees": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
], - "proposals": [
- {
- "id": 0
}
], - "preNote": "string",
- "result": "string",
- "active": true,
- "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "deal": {
- "id": 0,
- "name": "string"
}, - "purpose": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "proposals": [
- {
- "id": 0,
- "name": "string",
- "amount": 0,
- "proposalStatus": {
- "id": 0,
- "name": "string"
}
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "string"
]
}
]
}案件アクション詳細を取得します。
include_files=1 を指定するとファイル添付情報(files)を含みます| id required | integer アクションID |
| include_files | string Default: "0" Enum: "0" "1"
|
{- "files": [
- {
- "name": "string",
- "mimeType": "string",
- "url": "string"
}
], - "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "deal": {
- "id": 0,
- "name": "string"
}, - "purpose": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "proposals": [
- {
- "id": 0,
- "name": "string",
- "amount": 0,
- "proposalStatus": {
- "id": 0,
- "name": "string"
}
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "string"
]
}
]
}案件アクションを更新します。
invitees を指定した場合は全量置き換えになります| id required | integer アクションID |
| skipNotice | string Enum: "true" "false"
|
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 アクション詳細項目一覧 |
{- "purpose": {
- "id": 0
}, - "startDatetime": "2019-08-24T14:15:22Z",
- "endDatetime": "2019-08-24T14:15:22Z",
- "creator": {
- "id": 0
}, - "preNote": "string",
- "result": "string",
- "active": true,
- "invitees": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
], - "proposals": [
- {
- "id": 0
}
], - "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "deal": {
- "id": 0,
- "name": "string"
}, - "purpose": {
- "id": 0,
- "name": "string"
}, - "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "proposals": [
- {
- "id": 0,
- "name": "string",
- "amount": 0,
- "proposalStatus": {
- "id": 0,
- "name": "string"
}
}
], - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "string"
]
}
]
}案件アクションを削除します。
| id required | integer アクションID |
| skipNotice | string Enum: "true" "false"
|
{- "error": "The access token is invalid."
}案件アクションを一括登録します(v1同様の同期実行)。
| skipNotice | string Enum: "true" "false"
|
| dealTypeId required | integer 案件タイプID |
required | Array of objects 登録するアクションの配列 |
{- "dealTypeId": 0,
- "actions": [
- {
- "deal": {
- "id": 0
}, - "purpose": {
- "id": 0
}, - "startDatetime": "2019-08-24T14:15:22Z",
- "endDatetime": "2019-08-24T14:15:22Z",
- "creator": {
- "id": 0
}, - "invitees": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
], - "proposals": [
- {
- "id": 0
}
], - "preNote": "string",
- "result": "string",
- "active": true,
- "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
]
}
]
}[- 0
]提案タイプの一覧を取得します。
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "dealTypes": [
- {
- "id": 0,
- "name": "string"
}
], - "statuses": [
- {
- "proposalStatusId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "acceptanceReasons": [
- {
- "proposalAcceptanceReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "rejectionReasons": [
- {
- "proposalRejectionReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "customItems": [
- {
- "proposalCustomItemId": 0,
- "orderNum": 0,
- "name": "string"
}
]
}
]指定したIDの提案タイプ情報を取得します。
| id required | integer 提案タイプID |
{- "id": 0,
- "name": "string",
- "description": "string",
- "dealTypes": [
- {
- "id": 0,
- "name": "string"
}
], - "statuses": [
- {
- "proposalStatusId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "acceptanceReasons": [
- {
- "proposalAcceptanceReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "rejectionReasons": [
- {
- "proposalRejectionReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "customItems": [
- {
- "proposalCustomItemId": 0,
- "orderNum": 0,
- "name": "string"
}
]
}提案タイプを一括登録します(同期実行)。
required | Array of objects (ProposalTypeCreateInput) [ 1 .. 1000 ] items 登録する提案タイプの配列 |
{- "proposalTypes": [
- {
- "name": "string",
- "description": "string",
- "statuses": [
- {
- "proposalStatusId": 0,
- "orderNum": 0
}
], - "acceptanceReasons": [
- {
- "proposalAcceptanceReasonId": 0,
- "orderNum": 0
}
], - "rejectionReasons": [
- {
- "proposalRejectionReasonId": 0,
- "orderNum": 0
}
], - "customItems": [
- {
- "proposalCustomItemId": 0,
- "orderNum": 0
}
]
}
]
}[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "dealTypes": [
- {
- "id": 0,
- "name": "string"
}
], - "statuses": [
- {
- "proposalStatusId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "acceptanceReasons": [
- {
- "proposalAcceptanceReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "rejectionReasons": [
- {
- "proposalRejectionReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "customItems": [
- {
- "proposalCustomItemId": 0,
- "orderNum": 0,
- "name": "string"
}
]
}
]提案タイプを一括更新します(同期実行)。
id に更新対象の提案タイプIDを指定してくださいrequired | Array of objects (ProposalTypeUpdateInput) [ 1 .. 1000 ] items 更新する提案タイプの配列 |
{- "proposalTypes": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "statuses": [
- {
- "proposalStatusId": 0,
- "orderNum": 0
}
], - "acceptanceReasons": [
- {
- "proposalAcceptanceReasonId": 0,
- "orderNum": 0
}
], - "rejectionReasons": [
- {
- "proposalRejectionReasonId": 0,
- "orderNum": 0
}
], - "customItems": [
- {
- "proposalCustomItemId": 0,
- "orderNum": 0
}
]
}
]
}[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "dealTypes": [
- {
- "id": 0,
- "name": "string"
}
], - "statuses": [
- {
- "proposalStatusId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "acceptanceReasons": [
- {
- "proposalAcceptanceReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "rejectionReasons": [
- {
- "proposalRejectionReasonId": 0,
- "orderNum": 0,
- "name": "string"
}
], - "customItems": [
- {
- "proposalCustomItemId": 0,
- "orderNum": 0,
- "name": "string"
}
]
}
]提案ステータスを一括登録します(同期実行)。
required | Array of objects (ProposalStatusCreateInput) [ 1 .. 1000 ] items 登録する提案ステータスの配列 |
{- "proposalStatuses": [
- {
- "name": "string",
- "statusCategory": 0,
- "bookingCategory": 0,
- "description": "string"
}
]
}[- {
- "id": 0,
- "name": "string",
- "statusCategory": 0,
- "bookingCategory": 0,
- "description": "string"
}
]提案ステータスを一括更新します(同期実行)。
id に更新対象の提案ステータスIDを指定してくださいrequired | Array of objects (ProposalStatusUpdateInput) [ 1 .. 1000 ] items 更新する提案ステータスの配列 |
{- "proposalStatuses": [
- {
- "id": 0,
- "name": "string",
- "description": "string"
}
]
}[- {
- "id": 0,
- "name": "string",
- "statusCategory": 0,
- "bookingCategory": 0,
- "description": "string"
}
]採択理由を一括登録します(同期実行)。
required | Array of objects (ProposalReasonCreateInput) [ 1 .. 1000 ] items 登録する採択理由の配列 |
{- "proposalAcceptanceReasons": [
- {
- "name": "string",
- "description": "string"
}
]
}[- {
- "id": 0,
- "name": "string",
- "description": "string"
}
]採択理由を一括更新します(同期実行)。
id に更新対象の採択理由IDを指定してくださいrequired | Array of objects (ProposalReasonUpdateInput) [ 1 .. 1000 ] items 更新する採択理由の配列 |
{- "proposalAcceptanceReasons": [
- {
- "id": 0,
- "name": "string",
- "description": "string"
}
]
}[- {
- "id": 0,
- "name": "string",
- "description": "string"
}
]不採択理由を一括登録します(同期実行)。
required | Array of objects (ProposalReasonCreateInput) [ 1 .. 1000 ] items 登録する不採択理由の配列 |
{- "proposalRejectionReasons": [
- {
- "name": "string",
- "description": "string"
}
]
}[- {
- "id": 0,
- "name": "string",
- "description": "string"
}
]不採択理由を一括更新します(同期実行)。
id に更新対象の不採択理由IDを指定してくださいrequired | Array of objects (ProposalReasonUpdateInput) [ 1 .. 1000 ] items 更新する不採択理由の配列 |
{- "proposalRejectionReasons": [
- {
- "id": 0,
- "name": "string",
- "description": "string"
}
]
}[- {
- "id": 0,
- "name": "string",
- "description": "string"
}
]提案カスタム項目とグループの一覧を取得します。
{- "proposalCustomItemGroups": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "proposalCustomItems": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "itemKey": "string",
- "itemType": 0,
- "uiMode": 0,
- "orderNum": 0,
- "groupOrderNum": 0,
- "proposalCustomItemGroupId": 0,
- "groupName": "string",
- "customItemOptions": [
- {
- "id": 0,
- "label": "string",
- "description": "string",
- "value": 0,
- "orderNum": 0
}
]
}
]
}指定したIDの提案カスタム項目情報を取得します。
| id required | integer 提案カスタム項目ID |
{- "id": 0,
- "name": "string",
- "description": "string",
- "itemKey": "string",
- "itemType": 0,
- "uiMode": 0,
- "orderNum": 0,
- "groupOrderNum": 0,
- "proposalCustomItemGroupId": 0,
- "groupName": "string",
- "customItemOptions": [
- {
- "id": 0,
- "label": "string",
- "description": "string",
- "value": 0,
- "orderNum": 0
}
]
}提案カスタム項目とグループを一括登録します(同期実行)。
required | Array of objects [ 1 .. 1000 ] items 登録するカスタム項目の配列 |
Array of objects (ProposalCustomItemGroupCreateInput) <= 1000 items 登録するグループの配列 |
{- "proposalCustomItemGroups": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "proposalCustomItems": [
- {
- "name": "string",
- "description": "string",
- "itemKey": "string",
- "itemType": 0,
- "uiMode": 0,
- "orderNum": 0,
- "groupOrderNum": 0,
- "proposalCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "label": "string",
- "description": "string",
- "value": 0,
- "orderNum": 0
}
]
}
]
}{- "proposalCustomItemGroups": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "proposalCustomItems": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "itemKey": "string",
- "itemType": 0,
- "uiMode": 0,
- "orderNum": 0,
- "groupOrderNum": 0,
- "proposalCustomItemGroupId": 0,
- "groupName": "string",
- "customItemOptions": [
- {
- "id": 0,
- "label": "string",
- "description": "string",
- "value": 0,
- "orderNum": 0
}
]
}
]
}提案カスタム項目とグループを一括更新します(同期実行)。
id に更新対象のIDを指定してくださいrequired | Array of objects [ 1 .. 1000 ] items 更新するカスタム項目の配列 |
Array of objects (ProposalCustomItemGroupUpdateInput) <= 1000 items 更新するグループの配列 |
{- "proposalCustomItemGroups": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "proposalCustomItems": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "itemKey": "string",
- "itemType": 0,
- "uiMode": 0,
- "orderNum": 0,
- "groupOrderNum": 0,
- "proposalCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "label": "string",
- "description": "string",
- "value": 0,
- "orderNum": 0,
- "deleted": true
}
]
}
]
}{- "proposalCustomItemGroups": [
- {
- "id": 0,
- "name": "string",
- "orderNum": 0
}
], - "proposalCustomItems": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "itemKey": "string",
- "itemType": 0,
- "uiMode": 0,
- "orderNum": 0,
- "groupOrderNum": 0,
- "proposalCustomItemGroupId": 0,
- "groupName": "string",
- "customItemOptions": [
- {
- "id": 0,
- "label": "string",
- "description": "string",
- "value": 0,
- "orderNum": 0
}
]
}
]
}提案情報を登録します。
| itemKeyAsPropertyKey | string Enum: "true" "false"
|
required | object (ProposalCreateInput) 登録する提案 |
{- "proposal": {
- "dealId": 0,
- "proposalTypeId": 0,
- "proposalStatusId": 0,
- "name": "string",
- "reason": "string",
- "proposalAcceptanceReasonIds": [
- 0
], - "proposalRejectionReasonIds": [
- 0
], - "proposalCustoms": [
- {
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "dealProductDetailTypeId": 0,
- "price": 0,
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": 0,
- "unitCost": 0,
- "orderNum": 0,
- "grossProfitMargin": 100,
- "proposalProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "proposalProductDetailCustomDetails": [
- 0
]
}
]
}
]
}
}{- "id": 0,
- "name": "string",
- "dealId": 0,
- "proposalType": {
- "id": 0,
- "name": "string"
}, - "proposalStatus": {
- "id": 0,
- "name": "string",
- "statusCategory": 0,
- "bookingCategory": 0,
- "description": "string",
- "statusCategoryName": "string",
- "bookingCategoryName": "string"
}, - "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": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalRejectionReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalCustoms": [
- {
- "id": 0,
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "price": "string",
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": "string",
- "unitCost": "string",
- "orderNum": 0,
- "grossProfitMargin": "string",
- "proposalProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}
}, - "name": "string",
- "subtotalCost": "string",
- "subtotalProfit": "string"
}
]
}提案情報を検索し、カーソルページネーション形式で取得します。
filter で検索条件、sort で並び順を指定できます| limit | integer [ 1 .. 1000 ] Default: 100 取得件数(1〜1000、デフォルト100) |
| cursor | string or null 次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する |
| itemKeyAsPropertyKey | boolean Default: false
|
object 検索条件。異なる条件間はANDで絞り込みます | |
object 並び替え条件。省略時は created_at 降順。同値の場合は id を同じ方向で並べ替えます。 |
{- "limit": 100,
- "cursor": "string",
- "itemKeyAsPropertyKey": false,
- "filter": {
- "keyword": "string",
- "proposalTypeIds": [
- 0
], - "proposalStatusIds": [
- 0
], - "statusCategoryIds": [
- 0
], - "bookingCategoryIds": [
- 0
], - "dealTypeIds": [
- 0
], - "dealIds": [
- 0
], - "customerIds": [
- 0
], - "contactIds": [
- 0
], - "actionIds": [
- 0
], - "dealProductDetailTypeIds": [
- 0
], - "amountRange": {
- "from": 0,
- "to": 0
}, - "updatedAtRange": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "customItemFilters": [
- {
- "proposalCustomItemId": 0,
- "itemId": 0,
- "text": "string",
- "url": "string",
- "datetimeRange": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "decimalNumberRange": {
- "from": 0,
- "to": 0
}, - "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
]
}, - "sort": {
- "key": "string",
- "desc": true,
- "customItemId": 0
}
}{- "proposals": [
- {
- "id": 0,
- "name": "string",
- "dealId": 0,
- "proposalType": {
- "id": 0,
- "name": "string"
}, - "proposalStatus": {
- "id": 0,
- "name": "string",
- "statusCategory": 0,
- "bookingCategory": 0,
- "description": "string",
- "statusCategoryName": "string",
- "bookingCategoryName": "string"
}, - "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": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalRejectionReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalCustoms": [
- {
- "id": 0,
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "price": "string",
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": "string",
- "unitCost": "string",
- "orderNum": 0,
- "grossProfitMargin": "string",
- "proposalProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}
}, - "name": "string",
- "subtotalCost": "string",
- "subtotalProfit": "string"
}
]
}
], - "hasMore": true,
- "totalCount": 0,
- "nextCursor": "string"
}指定したIDの提案情報を取得します。
| id required | integer 提案ID |
| itemKeyAsPropertyKey | string Enum: "true" "false"
|
{- "id": 0,
- "name": "string",
- "dealId": 0,
- "proposalType": {
- "id": 0,
- "name": "string"
}, - "proposalStatus": {
- "id": 0,
- "name": "string",
- "statusCategory": 0,
- "bookingCategory": 0,
- "description": "string",
- "statusCategoryName": "string",
- "bookingCategoryName": "string"
}, - "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": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalRejectionReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalCustoms": [
- {
- "id": 0,
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "price": "string",
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": "string",
- "unitCost": "string",
- "orderNum": 0,
- "grossProfitMargin": "string",
- "proposalProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}
}, - "name": "string",
- "subtotalCost": "string",
- "subtotalProfit": "string"
}
]
}提案情報を更新します。
| id required | integer 提案ID |
| itemKeyAsPropertyKey | string Enum: "true" "false"
|
required | object (ProposalInput) 登録・更新する提案 |
{- "proposal": {
- "dealId": 0,
- "proposalTypeId": 0,
- "proposalStatusId": 0,
- "name": "string",
- "reason": "string",
- "proposalAcceptanceReasonIds": [
- 0
], - "proposalRejectionReasonIds": [
- 0
], - "proposalCustoms": [
- {
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "id": 0,
- "deleted": true,
- "dealProductDetailTypeId": 0,
- "price": 0,
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": 0,
- "unitCost": 0,
- "orderNum": 0,
- "grossProfitMargin": 100,
- "proposalProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "proposalProductDetailCustomDetails": [
- 0
]
}
]
}
]
}
}{- "id": 0,
- "name": "string",
- "dealId": 0,
- "proposalType": {
- "id": 0,
- "name": "string"
}, - "proposalStatus": {
- "id": 0,
- "name": "string",
- "statusCategory": 0,
- "bookingCategory": 0,
- "description": "string",
- "statusCategoryName": "string",
- "bookingCategoryName": "string"
}, - "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": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalRejectionReasons": [
- {
- "id": 0,
- "name": "string"
}
], - "proposalCustoms": [
- {
- "id": 0,
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "id": 0,
- "dealProductDetailTypeId": 0,
- "price": "string",
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": "string",
- "unitCost": "string",
- "orderNum": 0,
- "grossProfitMargin": "string",
- "proposalProductDetailCustoms": {
- "property1": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}, - "property2": {
- "id": 0,
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": "string",
- "proposalProductDetailCustomDetails": [
- 0
]
}
}, - "name": "string",
- "subtotalCost": "string",
- "subtotalProfit": "string"
}
]
}提案を一括登録します(同期実行)。
required | Array of objects (ProposalCreateInput) [ 1 .. 1000 ] items 登録する提案の配列 |
{- "proposals": [
- {
- "dealId": 0,
- "proposalTypeId": 0,
- "proposalStatusId": 0,
- "name": "string",
- "reason": "string",
- "proposalAcceptanceReasonIds": [
- 0
], - "proposalRejectionReasonIds": [
- 0
], - "proposalCustoms": [
- {
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "dealProductDetailTypeId": 0,
- "price": 0,
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": 0,
- "unitCost": 0,
- "orderNum": 0,
- "grossProfitMargin": 100,
- "proposalProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "proposalProductDetailCustomDetails": [
- 0
]
}
]
}
]
}
]
}[- 0
]提案を一括更新します(同期実行)。
id に更新対象の提案IDを指定してくださいrequired | Array of objects (ProposalBulkUpdateInput) [ 1 .. 1000 ] items 更新する提案の配列 |
{- "proposals": [
- {
- "dealId": 0,
- "proposalTypeId": 0,
- "proposalStatusId": 0,
- "name": "string",
- "reason": "string",
- "proposalAcceptanceReasonIds": [
- 0
], - "proposalRejectionReasonIds": [
- 0
], - "proposalCustoms": [
- {
- "proposalCustomItemId": 0,
- "text": "string",
- "url": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "selectedValue": 0,
- "selectedValues": [
- 0
], - "userIds": [
- 0
]
}
], - "proposalProductDetails": [
- {
- "id": 0,
- "deleted": true,
- "dealProductDetailTypeId": 0,
- "price": 0,
- "subtotal": 0,
- "memo": "string",
- "term": 999,
- "firstSales": "2019-08-24T14:15:22Z",
- "number": 0,
- "unitCost": 0,
- "orderNum": 0,
- "grossProfitMargin": 100,
- "proposalProductDetailCustoms": [
- {
- "dealProductDetailTypeCustomItemId": 0,
- "dealProductDetailTypeCustomItemOptionId": 0,
- "text": "string",
- "datetime": "2019-08-24T14:15:22Z",
- "decimalNumber": 0,
- "proposalProductDetailCustomDetails": [
- 0
]
}
]
}
], - "id": 0
}
]
}[- 0
]コンタクト詳細項目の定義の一覧と、案件のコンタクトタブに表示する項目を取得します。
orderNum、id の昇順で返します{- "contactCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "orderNum": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}
], - "dealContactTabSettings": [
- {
- "field": "name",
- "contactCustomItemId": 0
}
]
}案件のコンタクトタブに表示する項目を更新します。
Array of objects 案件のコンタクトタブに表示する項目。省略した場合は変更なし。送った一覧で置き換わる。必ず表示する5項目(name・email・company_name・department・position)を含め、最大10項目。配列の順は使われない |
{- "dealContactTabSettings": [
- {
- "field": "name"
}, - {
- "field": "email"
}, - {
- "field": "company_name"
}, - {
- "field": "department"
}, - {
- "field": "position"
}, - {
- "field": "phone"
}, - {
- "contactCustomItemId": 123
}
]
}{- "contactCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "orderNum": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
]
}
], - "dealContactTabSettings": [
- {
- "field": "name",
- "contactCustomItemId": 0
}
]
}ドメインに設定されたコンタクト詳細項目とコンタクト詳細項目グループを、設定画面と同じ並びで取得します。
{- "layout": [
- {
- "contactCustomItem": {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "contactCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
], - "contactCustomItemLabels": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "contactCustomItemGroup": {
- "id": 0,
- "name": "string",
- "contactCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "contactCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
], - "contactCustomItemLabels": [
- {
- "id": 0,
- "name": "string"
}
]
}
]
}
}
]
}ドメインにコンタクト詳細項目を1件、選択肢と合わせて登録します。
4)の single_select・multi_select は登録できません別の環境へ同じ並びで複製する手順は次のとおりです。複製先にコンタクト詳細項目・コンタクト詳細項目グループが無い場合に、複製元と同じ並びになります。
{"contactCustomItemId": 作ったコンタクト詳細項目の id} か {"contactCustomItemGroupId": 作ったグループの id})| name required | string コンタクト詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存 |
| itemType required | string コンタクト詳細項目タイプ。以下のいずれか
|
| itemKey | string or null API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。空文字・空白だけの時は未設定(null) |
| uiMode | integer or null 表示形式。itemType が single_select・multi_select の時のみ使用。省略・null の時は画面で作成した時と同じ値
|
| contactCustomItemGroupId | integer or null 所属するコンタクト詳細項目グループID。省略・null の時はグループに入れない |
object or null 並び位置。省略・null の時は入れる先(グループ内・グループ外)の末尾 | |
Array of objects or null (ContactCustomItemCreateOption) コンタクト詳細選択項目リスト。itemType が single_select・multi_select の時は1件以上必須で、配列の順が並び順。それ以外の itemType では空か省略 |
{- "name": "確度",
- "itemType": "single_select",
- "itemKey": "probability_rank",
- "uiMode": 1,
- "contactCustomItemGroupId": 10,
- "before": {
- "contactCustomItemId": 55
}, - "customItemOptions": [
- {
- "label": "高"
}, - {
- "label": "中"
}, - {
- "label": "低",
- "value": 9
}
]
}{- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "contactCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
], - "contactCustomItemLabels": [
- {
- "id": 0,
- "name": "string"
}
]
}コンタクト詳細項目1件を、送った項目だけ変更します。省略した項目は変更されません。
| id required | integer コンタクト詳細項目ID |
| name | string コンタクト詳細項目名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存 |
| itemType | string コンタクト詳細項目タイプ。変更不可(現在の値のみ指定可能) |
| itemKey | string or null API項目キー。100文字以内。ドメイン内で重複不可で、大文字・小文字の違いだけのキーも重複とみなす。null・空文字・空白だけの時は API項目キーを消す |
| uiMode | integer or null 表示形式。itemType が single_select・multi_select の時のみ変更可能。null には変更不可
|
| contactCustomItemGroupId | integer or null 所属するコンタクト詳細項目グループID。null の時はグループから出す。変更して before を省略した時は移動先の末尾に入る |
object or null 並び位置。省略した時は位置を変えない。null の時は移動先(グループ内・グループ外)の末尾。このコンタクト詳細項目自身は指定不可 | |
Array of objects or null (ContactCustomItemUpdateOption) コンタクト詳細選択項目リスト(差分)。itemType が single_select・multi_select の時のみ指定可能。送らなかった選択肢は変更しない。省略・null・空配列の時は変更しない。送った選択肢(削除を除く)は配列の順に並び、送らなかった選択肢は位置を保つ。表示形式が | |
Array of objects or null (ContactCustomItemUpdateLabel) コンタクト詳細項目ラベルリスト。itemType が label の時のみ指定可能で、取得したままのラベルのみ指定可能。省略・null・空配列の時は変更しない |
{- "customItemOptions": [
- {
- "id": 301,
- "label": "高(A)"
}, - {
- "label": "未定"
}, - {
- "id": 303,
- "deleted": true
}
]
}{- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "contactCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
], - "contactCustomItemLabels": [
- {
- "id": 0,
- "name": "string"
}
]
}コンタクト詳細項目を1件削除します。削除は取り消せません。
| id required | integer コンタクト詳細項目ID |
{- "error": "Bad Request",
- "messages": [
- "string"
]
}ドメインに、コンタクト詳細項目の入っていないコンタクト詳細項目グループを1件登録します。
| name required | string コンタクト詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。同じ名前のグループも登録可能 |
object 並び位置。グループに入っていないコンタクト詳細項目かコンタクト詳細項目グループの前に入り、後ろの要素は順にずれる。省略時は先頭。null は指定不可 |
{- "name": "商談情報",
- "before": {
- "contactCustomItemId": 55
}
}{- "id": 0,
- "name": "string",
- "contactCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "contactCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
], - "contactCustomItemLabels": [
- {
- "id": 0,
- "name": "string"
}
]
}
]
}コンタクト詳細項目グループ1件の名前と並び位置を更新します。
| id required | integer コンタクト詳細項目グループID |
| name | string コンタクト詳細項目グループ名。前後の空白(全角を含む)を除いて1〜100文字。前後の空白は除いて保存。null は指定不可 |
object or null 並び位置。グループに入っていないコンタクト詳細項目か他のコンタクト詳細項目グループの前に、中のコンタクト詳細項目ごと移り、他の要素は順にずれる。null は末尾。省略時は変更しない |
{- "before": null
}{- "id": 0,
- "name": "string",
- "contactCustomItems": [
- {
- "id": 0,
- "itemKey": "string",
- "name": "string",
- "itemType": "string",
- "uiMode": 0,
- "contactCustomItemGroupId": 0,
- "customItemOptions": [
- {
- "id": 0,
- "value": 0,
- "label": "string"
}
], - "contactCustomItemLabels": [
- {
- "id": 0,
- "name": "string"
}
]
}
]
}コンタクト詳細項目グループ1件を削除します。
| id required | integer コンタクト詳細項目グループID |
{- "error": "The access token is invalid."
}コンタクト一覧をカーソルページネーション形式で取得します。
contacts キーの配列 ({ contacts, hasMore, nextCursor, totalCount })GET /api/v1/contacts と互換のあるフィルタを、v2 形式で提供します| 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 更新日時による検索範囲(開始)
|
| updatedAtTo | string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 更新日時による検索範囲(終了)
|
| phoneNumber | string Example: phoneNumber=03-1111-2222 固定電話番号、携帯電話番号による検索
|
| sort | string Default: "-updated_at" Enum: "updated_at" "-updated_at" "created_at" "-created_at" "updatedAt" "-updatedAt" "createdAt" "-createdAt" 並び順
ソート可能 |
| itemKeyAsPropertyKey | string Enum: "true" "false" true の場合、contactCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します |
{- "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "hasMore": true,
- "nextCursor": "string",
- "totalCount": 0
}コンタクト情報を登録し、登録後のコンタクト情報を返します。
contactCustoms を常に含みますvalue にラベル名の配列を指定します。まだ無いラベル名はラベルが作成されますGET /v2/contact_setting/contact_custom_items)の contactCustomItemLabels で確認できます| name required | string コンタクト名 |
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 関連付けカスタムオブジェクト
|
{- "name": "山田太郎",
- "contactCustoms": [
- {
- "contactCustomItemId": 1,
- "value": "紹介経由"
}, - {
- "contactCustomItemId": 3,
- "value": "2026-10-28T10:30:00+09:00"
}, - {
- "contactCustomItemId": 4,
- "value": 120
}, - {
- "contactCustomItemId": 5,
- "value": "1234.56"
}, - {
- "contactCustomItemId": 6,
- "value": 2
}, - {
- "contactCustomItemId": 7,
- "value": [
- 1,
- 3
]
}, - {
- "itemKey": "owner_users",
- "value": [
- 101,
- 102
]
}, - {
- "contactCustomItemId": 9,
- "value": [
- "展示会",
- "セミナー"
]
}
]
}{- "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": [
- {
- "id": 5001,
- "contactCustomItemId": 1,
- "itemKey": null,
- "itemType": "text",
- "name": "紹介元",
- "text": "紹介経由"
}, - {
- "id": 5002,
- "contactCustomItemId": 2,
- "itemKey": null,
- "itemType": "url",
- "name": "Webサイト",
}, - {
- "id": 5003,
- "contactCustomItemId": 3,
- "itemKey": null,
- "itemType": "date",
- "name": "初回接触日",
- "datetime": "2026-10-28T10:30:00+09:00"
}, - {
- "id": 5004,
- "contactCustomItemId": 4,
- "itemKey": null,
- "itemType": "number",
- "name": "商談回数",
- "number": 120
}, - {
- "id": 5005,
- "contactCustomItemId": 5,
- "itemKey": null,
- "itemType": "decimal_number",
- "name": "スコア",
- "decimalNumber": "1234.56"
}, - {
- "id": 5006,
- "contactCustomItemId": 6,
- "itemKey": null,
- "itemType": "single_select",
- "name": "確度",
- "selectedOption": {
- "value": 2,
- "label": "中",
- "contactCustomItemOptionId": 302
}
}, - {
- "id": 5007,
- "contactCustomItemId": 7,
- "itemKey": null,
- "itemType": "multi_select",
- "name": "関心のある製品",
- "selectedOptions": [
- {
- "id": 9001,
- "label": "製品A",
- "contactCustomItemOptionId": 401
}, - {
- "id": 9002,
- "label": "製品C",
- "contactCustomItemOptionId": 403
}
]
}, - {
- "id": 5008,
- "contactCustomItemId": 8,
- "itemKey": "owner_users",
- "itemType": "user",
- "name": "担当",
- "selectedUsers": [
- {
- "id": 101,
- "name": "山田太郎",
- "email": "yamada@example.com"
}, - {
- "id": 102,
- "name": "佐藤花子",
- "email": "sato@example.com"
}
]
}, - {
- "id": 5009,
- "contactCustomItemId": 9,
- "itemKey": null,
- "itemType": "label",
- "name": "流入経路",
- "selectedLabels": [
- "展示会",
- "セミナー"
]
}, - {
- "id": null,
- "contactCustomItemId": 10,
- "itemKey": null,
- "itemType": "number",
- "name": "従業員数",
- "number": null
}
]
}コンタクト情報を検索します。
field の reference (参照先関連オブジェクト) として以下を指定できます。{ contacts, hasMore, nextCursor, totalCount })sort で指定できます(例: name / updated_at / created_at)。省略時は updated_at 降順(id 昇順タイブレーク)| limit | integer [ 1 .. 1000 ] Default: 100 取得件数(1〜1000、デフォルト100) |
| cursor | string 次ページ取得用カーソル。前回レスポンスの nextCursor をそのまま指定する。1ページ目と異なる sort を指定してcursorを使い回すと400が返る |
required | object (ContactSearchFilter) 絞り込み条件
|
object (ContactSearchSort) 並び替え条件。省略時は updated_at 降順(id 昇順タイブレーク)。 項目値が未設定のものは、昇順では先頭・降順では末尾に並びます。 |
{- "filter": {
- "compositeFilter": {
- "logicalOperator": "AND",
- "subFilters": [
- {
- "compositeFilter": { },
- "valueFilter": {
- "field": {
- "reference": "string",
- "name": "string",
- "customItemId": 0,
- "itemKey": "string"
}, - "comparisonOperator": "=",
- "value": {
- "stringValue": "string",
- "integerValue": 0,
- "decimalValue": 0.1,
- "datetimeValue": "2018-04-01T10:30:00+09:00"
}
}
}
]
}
}, - "sort": {
- "field": {
- "name": "updated_at"
}, - "order": "ASC"
}
}{- "contacts": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
]
}
], - "hasMore": true,
- "nextCursor": "string",
- "totalCount": 0
}コンタクト詳細を取得します。
include_related_objects=1 を指定するとカスタムオブジェクト連携情報(customObjects)を含みます| id required | integer コンタクトID |
| itemKeyAsPropertyKey | string Enum: "true" "false" true の場合、contactCustoms を配列ではなく、itemKey(API項目キー)をプロパティ名にしたオブジェクトで返します |
| include_related_objects | integer Default: 0
|
{- "id": 0,
- "name": "string",
- "email": "string",
- "tel": "string",
- "mobileTel": "string",
- "address": "string",
- "dept": "string",
- "position": "string",
- "memo": "string",
- "marketoLeadScore": 0,
- "customer": {
- "id": 0,
- "name": "string"
}, - "lifecycleStages": [
- {
- "lifecycleStageTypeId": 0,
- "id": 0,
- "name": "string"
}
], - "contactCustoms": [
- {
- "id": 0,
- "contactCustomItemId": 0,
- "itemKey": "string",
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "number": 123456,
- "decimalNumber": "1234.56",
- "selectedOption": {
- "label": "string",
- "contactCustomItemOptionId": 0
}, - "selectedOptions": [
- {
- "id": 0,
- "label": "string",
- "contactCustomItemOptionId": 0
}
], - "selectedUsers": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "selectedLabels": [
- "展示会",
- "セミナー"
]
}
], - "customObjects": [
- {
- "id": 0,
- "customObjectDefKey": "string"
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}コンタクト情報を更新します。指定した属性だけを更新します。
data で包まずに返し、contactCustoms を常に含みます"value": null を送りますvalue にラベル名の配列を指定します。まだ無いラベル名はラベルが作成されますGET /v2/contact_setting/contact_custom_items)の contactCustomItemLabels で確認できますvalue の省略で全て外れ、ラベル型の項目を送らなければ変わりませんselectedLabels で確認できます| id required | integer コンタクトID |
| name | string コンタクト名 |
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 関連付けカスタムオブジェクト
|
{- "contactCustoms": [
- {
- "contactCustomItemId": 1,
- "value": "紹介経由"
}, - {
- "contactCustomItemId": 3,
- "value": "2026-10-28T10:30:00+09:00"
}, - {
- "contactCustomItemId": 4,
- "value": 120
}, - {
- "contactCustomItemId": 5,
- "value": "1234.56"
}, - {
- "contactCustomItemId": 6,
- "value": 2
}, - {
- "contactCustomItemId": 7,
- "value": [
- 1,
- 3
]
}, - {
- "itemKey": "owner_users",
- "value": [
- 101,
- 102
]
}, - {
- "contactCustomItemId": 9,
- "value": [
- "展示会",
- "セミナー"
]
}
]
}{- "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": [
- {
- "id": 5001,
- "contactCustomItemId": 1,
- "itemKey": null,
- "itemType": "text",
- "name": "紹介元",
- "text": "紹介経由"
}, - {
- "id": 5002,
- "contactCustomItemId": 2,
- "itemKey": null,
- "itemType": "url",
- "name": "Webサイト",
}, - {
- "id": 5003,
- "contactCustomItemId": 3,
- "itemKey": null,
- "itemType": "date",
- "name": "初回接触日",
- "datetime": "2026-10-28T10:30:00+09:00"
}, - {
- "id": 5004,
- "contactCustomItemId": 4,
- "itemKey": null,
- "itemType": "number",
- "name": "商談回数",
- "number": 120
}, - {
- "id": 5005,
- "contactCustomItemId": 5,
- "itemKey": null,
- "itemType": "decimal_number",
- "name": "スコア",
- "decimalNumber": "1234.56"
}, - {
- "id": 5006,
- "contactCustomItemId": 6,
- "itemKey": null,
- "itemType": "single_select",
- "name": "確度",
- "selectedOption": {
- "value": 2,
- "label": "中",
- "contactCustomItemOptionId": 302
}
}, - {
- "id": 5007,
- "contactCustomItemId": 7,
- "itemKey": null,
- "itemType": "multi_select",
- "name": "関心のある製品",
- "selectedOptions": [
- {
- "id": 9001,
- "label": "製品A",
- "contactCustomItemOptionId": 401
}, - {
- "id": 9002,
- "label": "製品C",
- "contactCustomItemOptionId": 403
}
]
}, - {
- "id": 5008,
- "contactCustomItemId": 8,
- "itemKey": "owner_users",
- "itemType": "user",
- "name": "担当",
- "selectedUsers": [
- {
- "id": 101,
- "name": "山田太郎",
- "email": "yamada@example.com"
}, - {
- "id": 102,
- "name": "佐藤花子",
- "email": "sato@example.com"
}
]
}, - {
- "id": 5009,
- "contactCustomItemId": 9,
- "itemKey": null,
- "itemType": "label",
- "name": "流入経路",
- "selectedLabels": [
- "展示会",
- "セミナー"
]
}, - {
- "id": null,
- "contactCustomItemId": 10,
- "itemKey": null,
- "itemType": "number",
- "name": "従業員数",
- "number": null
}
]
}指定したコンタクトに紐づくアクション一覧をカーソルページネーション形式で取得します。
actions キーの配列を含む構造({ actions, hasMore, nextCursor, totalCount })dataType 未指定時はコンタクトアクション(1)・案件アクション(0)の両方を返しますcontact_id に all を指定すると全コンタクトのアクションを対象としますrequired | integer or string コンタクトIDを指定してアクションを検索します。 コンタクトIDの代わりに、allと指定することでコンタクトIDを跨いだアクションの取得が可能です。
この場合、アクションに紐づくコンタクトのうち1件(コンタクトID昇順の先頭)が |
| 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" 並び順
ソート可能 |
| dataType | integer Enum: 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:完了 |
{- "actions": [
- {
- "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": "string",
- "pattern": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "contact": {
- "id": 0,
- "name": "string"
}, - "deal": {
- "id": 0,
- "name": "string"
}, - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "string"
]
}
]
}
], - "hasMore": true,
- "nextCursor": "string",
- "totalCount": 0
}コンタクトアクションを登録します。
pattern / startDatetime / endDatetime / creator は必須ですactionCustoms(アクション詳細)を常に含めます+09:00) で返します| contact_id required | integer コンタクトID |
| skipNotice | string Enum: "true" "false"
|
| 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 アクションに紐づける他のコンタクト |
{- "startDatetime": "2018-04-01T10:30:00+09:00",
- "endDatetime": "2018-04-01T10:30:00+09:00",
- "creator": {
- "id": 0
}, - "invitees": [
- {
- "id": 0
}
], - "preNote": "string",
- "result": "string",
- "active": true,
- "pattern": {
- "id": 0
}, - "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
], - "contacts": [
- {
- "id": 0
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "contact": {
- "id": 0,
- "name": "string"
}, - "deal": {
- "id": 0,
- "name": "string"
}, - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "A",
- "B",
- "C"
]
}
]
}コンタクトアクション詳細を取得します。
include_files=1 を指定するとファイル添付情報(files)を含みます| contact_id required | integer コンタクトID |
| id required | integer アクションID |
| include_files | string Default: "0" Enum: "0" "1"
|
{- "files": [
- {
- "name": "string",
- "mimeType": "string",
- "url": "string"
}
], - "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "contact": {
- "id": 0,
- "name": "string"
}, - "deal": {
- "id": 0,
- "name": "string"
}, - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "string"
]
}
]
}コンタクトアクション情報を更新します。
actionCustoms(アクション詳細)を常に含めます| contact_id required | integer コンタクトID |
| id required | integer アクションID |
| skipNotice | string Enum: "true" "false"
|
| 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 アクション詳細項目一覧 |
{- "startDatetime": "2018-04-01T10:30:00+09:00",
- "endDatetime": "2018-04-01T10:30:00+09:00",
- "creator": {
- "id": 0
}, - "invitees": [
- {
- "id": 0
}
], - "preNote": "string",
- "result": "string",
- "active": true,
- "pattern": {
- "id": 0
}, - "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
]
}{- "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": {
- "id": 0,
- "name": "string"
}, - "creator": {
- "id": 0,
- "name": "string"
}, - "invitees": [
- {
- "id": 0,
- "name": "string"
}
], - "contact": {
- "id": 0,
- "name": "string"
}, - "deal": {
- "id": 0,
- "name": "string"
}, - "actionCustoms": [
- {
- "id": 0,
- "actionCustomItemId": 0,
- "itemType": "string",
- "name": "string",
- "text": "テキスト",
- "datetime": "2018-04-01T10:30:00+09:00",
- "url": "string",
- "decimalNumber": "1234.56",
- "selectedOption": {
- "actionCustomItemOptionId": 0,
- "label": "string"
}, - "selectedOptions": [
- {
- "id": 0,
- "actionCustomItemOptionId": 0,
- "label": "string"
}
], - "selectedLabels": [
- "A",
- "B",
- "C"
]
}
]
}コンタクトアクションを削除します。
| contact_id required | integer コンタクトID |
| id required | integer アクションID |
| skipNotice | string Enum: "true" "false"
|
{- "error": "The access token is invalid."
}コンタクトアクションを一括登録します。
| skipNotice | string Enum: "true" "false"
|
required | Array of objects <= 1000 items 登録するコンタクトアクション一覧 |
{- "actions": [
- {
- "contact": {
- "id": 0
}, - "pattern": {
- "id": 0
}, - "startDatetime": "2018-04-01T10:30:00+09:00",
- "endDatetime": "2018-04-01T11:30:00+09:00",
- "creator": {
- "id": 0
}, - "invitees": [
- {
- "id": 0
}
], - "preNote": "string",
- "result": "string",
- "active": true,
- "actionCustoms": [
- {
- "itemKey": "string",
- "value": "string"
}
], - "files": [
- {
- "name": "string",
- "path": "string"
}
]
}
]
}[- 0
]ライフサイクルステージ種別と、それに紐づくライフサイクルステージの一覧を取得します。
{- "lifecycleStageTypes": [
- {
- "id": 0,
- "name": "string",
- "lifecycleStages": [
- {
- "id": 0,
- "name": "string"
}
]
}
]
}ライフサイクルステージの追加・名前変更・並べ替え・削除を1回で行います。
| 削除できない条件 | 対処 |
|---|---|
| コンタクトに付いている | そのコンタクトのライフサイクルステージを変える |
| オートメーションの条件・「コンタクトを更新」で使われている(停止中のオートメーションを含む) | オートメーションを変える |
| Webフォームの初期値に指定されている(Webフォーム機能が有効な場合だけ) | フォームの初期値を変える |
| ライフサイクルステージ自動更新で使われている | 自動更新の設定を変える |
| 削除するとライフサイクルステージが1つも残らない | 追加と一緒に送る |
Array of objects ライフサイクルステージ種別のリスト。省略・空配列の場合は変更なし |
{- "lifecycleStageTypes": [
- {
- "id": 1,
- "lifecycleStages": [
- {
- "id": 11
}, - {
- "name": "MQL"
}, - {
- "id": 12,
- "name": "SQL(営業確認済み)"
}, - {
- "id": 13,
- "deleted": true
}
]
}
]
}{- "lifecycleStageTypes": [
- {
- "id": 0,
- "name": "string",
- "lifecycleStages": [
- {
- "id": 0,
- "name": "string"
}
]
}
]
}案件タイプのフェーズごとに、案件がそのフェーズになったときにコンタクトのライフサイクルステージをどう変えるか(ライフサイクルステージ自動更新)を取得します。
| deal_type_id required | integer 案件タイプID |
{- "preventBackwardLifecycleStageAutoUpdate": true,
- "processingStatus": true,
- "phaseLifecycleStageMaps": [
- {
- "phaseId": 0,
- "lifecycleStageId": 0
}
]
}案件タイプのフェーズごとのライフサイクルステージ自動更新と、前のステージに自動更新されないようにする設定を更新します。
| deal_type_id required | integer 案件タイプID |
| preventBackwardLifecycleStageAutoUpdate | boolean or null 前のステージに自動更新されないようにする(全案件タイプに共通の設定)。省略・null の場合は変更なし |
Array of objects フェーズごとの自動更新の設定のリスト。省略・空配列の場合は変更なし。null は指定不可(400) |
{- "preventBackwardLifecycleStageAutoUpdate": true,
- "phaseLifecycleStageMaps": [
- {
- "phaseId": 201,
- "lifecycleStageId": 12
}, - {
- "phaseId": 202,
- "lifecycleStageId": 0
}, - {
- "phaseId": 203,
- "lifecycleStageId": null
}
]
}{- "preventBackwardLifecycleStageAutoUpdate": true,
- "processingStatus": true,
- "phaseLifecycleStageMaps": [
- {
- "phaseId": 0,
- "lifecycleStageId": 0
}
]
}カスタムオブジェクト定義の一覧を取得します。
customObjectDefs キー({ totalCount, page, customObjectDefs })page によるページ方式(1ページあたり100件固定。取得件数の指定はできません)customObjectItemDefs)を含みません。項目定義はカスタムオブジェクト定義情報(GET /v2/custom_object_defs/{key})で取得してください| page | integer >= 1 Default: 1 ページ番号(1始まり)。未指定時は1ページ目 |
| searchWord | string 名前が部分一致するカスタムオブジェクト定義を検索します |
{- "totalCount": 0,
- "page": 0,
- "customObjectDefs": [
- {
- "key": "string",
- "name": "string",
- "enableBi": true,
- "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}
]
}カスタムオブジェクト定義を登録します。
| name required | string カスタムオブジェクト名 |
| enableBi | boolean BIのデータソースとして使用するかどうか |
| key | string カスタムオブジェクト定義キー。省略時は自動採番されます |
Array of objects (CustomObjectItemDefInput) 項目定義一覧 |
{- "name": "string",
- "enableBi": true,
- "key": "string",
- "customObjectItemDefs": [
- {
- "name": "string",
- "key": "string",
- "itemType": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string"
}
]
}
]
}{- "key": "string",
- "name": "string",
- "enableBi": true,
- "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "customObjectItemDefs": [
- {
- "key": "string",
- "name": "string",
- "itemType": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string"
}
]
}
]
}カスタムオブジェクト定義の情報を項目定義とあわせて取得します。
customObjectOptionDefs)は単一選択・複数選択タイプの項目のみが持ちます| key required | string カスタムオブジェクト定義キー |
{- "key": "string",
- "name": "string",
- "enableBi": true,
- "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "customObjectItemDefs": [
- {
- "key": "string",
- "name": "string",
- "itemType": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string"
}
]
}
]
}カスタムオブジェクト定義を更新します。
key で既存を特定します。既存に無い key を指定すると新規追加になり itemType が必要ですnewKey を指定しますdelete に true を指定してください| key required | string カスタムオブジェクト定義キー |
| name | string カスタムオブジェクト名 |
| enableBi | boolean BIのデータソースとして使用するかどうか |
| newKey | string 新しい定義キーを指定します |
Array of objects (CustomObjectItemDefUpdateInput) 項目定義一覧 |
{- "name": "string",
- "enableBi": true,
- "newKey": "string",
- "customObjectItemDefs": [
- {
- "key": "string",
- "delete": true,
- "name": "string",
- "newKey": "string",
- "itemType": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string",
- "newKey": "string",
- "delete": true
}
]
}
]
}{- "key": "string",
- "name": "string",
- "enableBi": true,
- "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00",
- "customObjectItemDefs": [
- {
- "key": "string",
- "name": "string",
- "itemType": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string"
}
]
}
]
}カスタムオブジェクト定義を削除します。
| key required | string カスタムオブジェクト定義キー |
{- "error": "The access token is invalid."
}カスタムオブジェクト定義に項目を1件登録します。
before を指定すると、その項目キーの手前に挿入します(省略時は末尾に追加)customObjectOptionDefs の指定が必須です| custom_object_def_key required | string カスタムオブジェクト定義キー |
| name required | string 項目名 |
| itemType required | string text: 文字列タイプ
|
| key | string 項目キー。省略した場合は自動で設定されます |
| before | string 指定した項目キーの手前に項目を追加します |
Array of objects 選択肢定義一覧。単一選択・複数選択タイプでは必須です |
{- "name": "string",
- "itemType": "string",
- "key": "string",
- "before": "string",
- "customObjectOptionDefs": [
- {
- "name": "string",
- "key": "string"
}
]
}{- "key": "string",
- "name": "string",
- "itemType": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string"
}
]
}カスタムオブジェクト定義の項目を1件更新します。
key で対象を指定します。存在しない key を指定した場合、または key を省略した場合は選択肢を追加しますkey に delete を指定した場合は、追加も削除もされませんcustomObjectOptionDefs を指定すると、指定した並び順で選択肢の表示順を採番し直します| custom_object_def_key required | string カスタムオブジェクト定義キー |
| key required | string 項目キー |
| name | string 項目名 |
| newKey | string 新しい項目キーを指定します |
Array of objects 選択肢定義一覧。指定した選択肢のみを更新します |
{- "name": "string",
- "newKey": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string",
- "newKey": "string",
- "delete": true
}
]
}{- "key": "string",
- "name": "string",
- "itemType": "string",
- "customObjectOptionDefs": [
- {
- "key": "string",
- "name": "string"
}
]
}カスタムオブジェクト定義の項目を削除します。
| custom_object_def_key required | string カスタムオブジェクト定義キー |
| key required | string 項目キー |
{- "error": "The access token is invalid."
}カスタムオブジェクトの一覧をカーソルページネーション形式で取得します。
limit は指定できません)cursor は 1回目のリクエストと同じ絞り込み条件・sort とあわせて指定してください(異なる場合は 400 を返します)| custom_object_def_key required | string カスタムオブジェクト定義キー |
| カスタムオブジェクト項目キー | string カスタムオブジェクト項目定義の「項目キー」を検索キーとして指定します。 検索条件に指定できるのは下記の項目タイプです。
ただし下記の制御用パラメータと同名の項目キーは、検索条件には指定できません。
例)カスタムオブジェクト「商品」の定義が以下だった場合
という検索条件を指定する場合、以下のようにクエリパラメータを設定します。
| |||||||||
| 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" 並び順 ソート可能 |
{- "totalCount": 0,
- "hasMore": true,
- "nextCursor": "string",
- "customObjects": [
- {
- "id": 0,
- "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}
]
}カスタムオブジェクトを登録します。
deals / customers / contacts で案件・取引先・コンタクトへの関連付けを同時に登録できます(1オブジェクトあたり最大1000件)| custom_object_def_key required | string カスタムオブジェクト定義キー |
| カスタムオブジェクト項目 | any カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。 項目タイプごとに以下の値を設定してください。
例)カスタムオブジェクト「商品」の定義が以下だった場合
というデータを追加するリクエストペイロードは以下になります。
| |||||||||
Array of objects 関連付け案件 | ||||||||||
Array of objects 関連付け取引先 | ||||||||||
Array of objects 関連付けコンタクト |
{- "カスタムオブジェクト項目": null,
- "deals": [
- {
- "id": 0,
- "delete": true
}
], - "customers": [
- {
- "id": 0,
- "delete": true
}
], - "contacts": [
- {
- "id": 0,
- "delete": true
}
]
}{- "id": 0,
- "textKey": "string",
- "dateKey": "2018-04-01T10:30:00+09:00",
- "numberKey": 0,
- "decimalKey": "string",
- "urlKey": "string",
- "singleKey": {
- "key": "string",
- "name": "string"
}, - "multiKey": [
- {
- "key": "string",
- "name": "string"
}
], - "userKey": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}指定したカスタムオブジェクトを取得します。
include_related_objects=1 を指定すると、関連付けオブジェクトの情報を含めて返します| custom_object_def_key required | string カスタムオブジェクト定義キー |
| id required | integer カスタムオブジェクトID |
| include_related_objects | integer
|
{- "id": 0,
- "textKey": "string",
- "dateKey": "2018-04-01T10:30:00+09:00",
- "numberKey": 0,
- "decimalKey": "string",
- "urlKey": "string",
- "singleKey": {
- "key": "string",
- "name": "string"
}, - "multiKey": [
- {
- "key": "string",
- "name": "string"
}
], - "userKey": [
- {
- "id": 0,
- "name": "string",
- "email": "string"
}
], - "deals": [
- {
- "id": 0
}
], - "customers": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
], - "createdAt": "2018-04-01T10:30:00+09:00",
- "updatedAt": "2018-04-01T10:30:00+09:00"
}カスタムオブジェクトを更新します。リクエストに含まれた項目のみ更新されます(部分更新)。
deals / customers / contacts)は { "id": N } で追加、{ "id": N, "delete": true } で解除します| custom_object_def_key required | string カスタムオブジェクト定義キー |
| id required | integer カスタムオブジェクトID |
| カスタムオブジェクト項目 | any カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。 項目タイプごとに以下の値を設定してください。
例)カスタムオブジェクト「商品」の定義が以下だった場合
というデータを追加するリクエストペイロードは以下になります。
|
{- "カスタムオブジェクト項目": null
}{ }カスタムオブジェクトを一括登録します(v1同様の同期実行)。
| custom_object_def_key required | string カスタムオブジェクト定義キー |
required | Array of objects (CustomObjectBulkCreateItem) <= 1000 items 登録するカスタムオブジェクトの配列。各要素はカスタムオブジェクト項目定義のキーをプロパティとして指定 |
{- "customObjects": [
- {
- "カスタムオブジェクト項目": null,
- "deals": [
- {
- "id": 0
}
], - "customers": [
- {
- "id": 0
}
], - "contacts": [
- {
- "id": 0
}
]
}
]
}[- 0
]カスタムオブジェクトを一括更新します(v1同様の同期実行)。
| custom_object_def_key required | string カスタムオブジェクト定義キー |
required | Array of objects (CustomObjectBulkUpdateItem) <= 1000 items 更新するカスタムオブジェクトの配列。各要素は更新対象の |
{- "customObjects": [
- {
- "id": 0,
- "カスタムオブジェクト項目": null,
- "deals": [
- {
- "id": 0,
- "delete": true
}
], - "customers": [
- {
- "id": 0,
- "delete": true
}
], - "contacts": [
- {
- "id": 0,
- "delete": true
}
]
}
]
}[- 0
]条件に一致するカスタムオブジェクトを一括削除します。
POST /v2/custom_object_defs/{custom_object_def_key}/custom_objects/bulk_delete を使用してください| custom_object_def_key required | string カスタムオブジェクト定義キー |
| createdAtFrom | string <date-time> 作成日時による検索範囲(開始) |
| createdAtTo | string <date-time> 作成日時による検索範囲指定(終了) |
| updatedAtFrom | string <date-time> 更新日時による検索範囲(開始) |
| updatedAtTo | string <date-time> 更新日時による検索範囲指定(終了) |
{- "error": "The access token is invalid."
}リクエストボディで指定したIDのカスタムオブジェクトを一括削除します。
customObjectIds が空配列・未指定の場合は1件も削除しませんDELETE /v2/custom_object_defs/{custom_object_def_key}/custom_objects/bulk を使用してください| custom_object_def_key required | string カスタムオブジェクト定義キー |
| customObjectIds | Array of integers <= 1000 items カスタムオブジェクトIDのリスト。最大1000件 |
{- "customObjectIds": [
- 0
]
}{- "error": "Bad Request",
- "messages": [
- "string"
]
}label は実際に表示されている名称です。名称が変更されていない場合は defaultLabel と同じ値を返しますdefaultLabel はシステム標準の名称です{- "customer": {
- "defaultLabel": "string",
- "label": "string"
}, - "deal": {
- "defaultLabel": "string",
- "label": "string"
}, - "contact": {
- "defaultLabel": "string",
- "label": "string"
}, - "action": {
- "defaultLabel": "string",
- "label": "string"
}
}| 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 でシステム標準の名称に戻す |
{- "customer": "string",
- "deal": "string",
- "contact": "string",
- "action": "string"
}{- "customer": {
- "defaultLabel": "string",
- "label": "string"
}, - "deal": {
- "defaultLabel": "string",
- "label": "string"
}, - "contact": {
- "defaultLabel": "string",
- "label": "string"
}, - "action": {
- "defaultLabel": "string",
- "label": "string"
}
}監査ログの一覧をv1同様のページ方式で取得します。
time)の昇順で返しますpage を指定して続きを取得します| page | integer >= 1 Default: 1 ページ番号(1始まり)。未指定時は1ページ目 |
| startTime | string <date-time> 開始日時。例 |
| endTime | string <date-time> 終了日時。例 |
{- "totalCount": 0,
- "page": 0,
- "audits": [
- {
- "id": 0,
- "dataId": 0,
- "time": "2025-04-01T10:30:00+09:00",
- "dataType": "string",
- "operationType": "create",
- "details": null,
- "user": {
- "id": 0,
- "name": "string",
- "email": "string"
}
}
]
}| 更新日 | API | 内容 |
|---|---|---|
| 2026/11/11 | 取引先設定(CustomerSetting) アクション設定(ActionSetting) 案件設定(DealSetting) コンタクト設定(ContactSetting) ライフサイクルステージ設定(LifecycleStageSetting) | 各オブジェクトの設定(詳細項目・詳細項目グループ・案件タイプ・アクション設定など)を取得・登録・更新・削除するAPIを新規追加 |
| 2026/10/14 | オブジェクト名称(ObjectLabels) | オブジェクト名称を取得・更新するAPIを新規追加 |