Mazrica Open API References (v1)

Download OpenAPI specification:Download

URL: https://product-senses.mazrica.com/

Overview

Mazricaユーザ向けAPIです。本ドキュメントを確認頂き、ご利用ください。また随時APIは拡張していきますので、ご希望のものがない場合は右下のチャットサポートからリクエストください。今後の開発の参考とさせて頂きます。

Introduction

Endpoints

APIのエンドポイントのベースURLは以下になります。バージョンの v1 も含めてリクエストしてください。 {PATH_TO_REQUEST} は利用するAPIのパスを指定してください。

https://senses-open-api.mazrica.com/v1/{PATH_TO_REQUEST}

Requests Limit

APIのリクエストには以下の制限があります。制限を超過した場合は 429 Too Many Requests がレスポンスされます。

10,000リクエスト / 日
- リクエスト数のリセットタイミングは UTC となります
3リクエスト / 秒 (バースト 100)
- トークンバケット方式を利用した仕組みとなります

Sort

リストを返す API では、要素が「更新日時の降順」でソートされて返ってきます。ソート順を変更するには sort パラメータに並び替えのキーとなるプロパティを指定します。キーの前に - (ダッシュ) をつけると降順となります。以下を参考にしてください。

更新日時の昇順でソートする場合

https://senses-open-api.mazrica.com/v1/customers?sort=updatedAt

複数指定も可能(更新日時の降順かつidの昇順)

https://senses-open-api.mazrica.com/v1/customers?sort=-updatedAt,id

Authentication

X-Api-Key

APIの利用には APK Key が必要です。以下をご参考にMazricaの管理機能から API Key を発行できます。APIをリクエストする際、発行した API Key をリクエストに含めてください。

オンラインマニュアル: MazricaAPIを利用する – Mazrica
以下のように生成した APK Key をリクエスト時のヘッダで X-Api-Key に指定してください

curl -X GET \
  https://senses-open-api.mazrica.com/v1/domains/settings \
  -H 'X-Api-Key: YOUR_API_KEY'

Security Scheme Type	API Key
Header parameter name:	X-Api-Key

チーム(Domains)

チーム設定情報取得 Deprecated

所属しているチームの設定情報を取得

このエンドポイントは非推奨です。ユーザー数やチーム設定が多い場合、性能に問題が出る可能性があります。各種設定の取得には、以下の設定別エンドポイントをご利用ください。

ユーザー情報
ロール情報
取引先設定情報
案件設定情報
コンタクト設定情報

Authorizations:

X-Api-Key

Responses

200

404

Not Found

500

Internal Server Error

get /domains/settings

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/domains/settings

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"dealTypes": 
[
{"id": 0,
"name": "string",
"phases": 
[
{"id": 0,
"name": "string",
"status": 1
}
],
"products": 
[
{"id": 0,
"name": "string"
}
],
"probabilities": 
[
{"id": 0,
"name": "string"
}
],
"channels": 
[
{"id": 0,
"name": "string"
}
],
"endPhaseReasons": 
[
{"id": 0,
"name": "string"
}
],
"actionsPurposes": 
[
{"id": 0,
"name": "string",
"pattern": 0,
"patternName": "string"
}
],
"dealCustomItems": 
[
{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": null,
"orderNum": "string",
"customItemOptions": 
[
{"id": 0,
"value": "string",
"label": "string"
}
]
}
],
"dealProductDetailTypes": 
[
{"id": 0,
"name": "string",
"unit": "string",
"price": 0,
"billingType": 
{"id": 1,
"key": "lump",
"name": "一括"
},
"roundType": 
{"id": 1,
"key": "round_down",
"name": "切り捨て"
},
"memo": "string"
}
]
}
],
"users": 
[
{"id": 0,
"name": "string",
"email": "string"
}
],
"roles": 
[
{"id": 0,
"name": "string"
}
]
}

ユーザー(Users)

ユーザー情報リスト取得

ユーザー情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

page	integer ページ

Responses

200

500

Internal Server Error

get /users

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/users

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"users": 
[
{"id": 0,
"name": "string",
"email": "string",
"userGroups": 
[
{"id": 0,
"name": "string"
}
]
}
]
}

ユーザーグループ(UserGroups)

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

ユーザーグループ情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

userId	integer ユーザーID
page	integer ページ

Responses

200

500

Internal Server Error

get /user_groups

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/user_groups

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"userGroups": 
[
{"id": 0,
"name": "string",
"orderNum": 0,
"users": 
[
{"id": 0,
"name": "string",
"email": "string"
}
]
}
]
}

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

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

Authorizations:

X-Api-Key

path Parameters

required

integer

ユーザーグループID

Request Body schema: application/json

name	string Nullable ユーザーグループ名 name指定なし->ユーザーグループ名は更新されない nameが空文字->ユーザーグループ名は更新されない

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

patch /user_groups/{:id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/user_groups/{:id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"orderNum": 0
}

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

指定した1つのユーザーグループに指定したユーザー1名を紐づかせます

Authorizations:

X-Api-Key

path Parameters

userGroupId required	integer ユーザーグループID
userId required	integer ユーザーID

Request Body schema: application/json

userId

integer

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

userId指定なし->何も追加されず200を返却

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

post /user_groups/{:userGroupId}/users

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/user_groups/{:userGroupId}/users

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"userId": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"orderNum": 0,
"users": 
[
{"id": 0,
"name": "string",
"email": "string"
}
]
}

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

指定したユーザー1名を指定した1つのユーザーグループから除外します
ユーザー自体が削除されることはありません

Authorizations:

X-Api-Key

path Parameters

userGroupId required	integer ユーザーグループID
userId required	integer ユーザーID

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

delete /user_groups/{:userGroupId}/users/{:userId}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/user_groups/{:userGroupId}/users/{:userId}

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

指定した1つのユーザーグループに紐づくユーザーを指定した複数名のユーザーに更新します

Authorizations:

X-Api-Key

path Parameters

userGroupId

required

integer

ユーザーグループID

Request Body schema: application/json

userIds

Array of integers Nullable

ユーザーID(複数指定)

userIds指定なし->ユーザーグループメンバーは更新されない

userIds:[]->対象グループの所属ユーザーを全除外

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

patch /user_groups/{:userGroupId}/users/bulk

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/user_groups/{:userGroupId}/users/bulk

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"userIds": 
[0
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"orderNum": 0,
"users": 
[
{"id": 0,
"name": "string",
"email": "string"
}
]
}

ロール(Roles)

ロール情報リスト取得

ロール情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

page	integer ページ

Responses

200

500

Internal Server Error

get /roles

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/roles

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"roles": 
[
{"id": 0,
"name": "string"
}
]
}

アクション設定(ActionSetting)

アクション設定

アクション設定の取得

Authorizations:

X-Api-Key

Responses

200

get /action_setting

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/action_setting

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"actionCustomItems": 
[
{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"actionCustomItemOptions": 
[
{"id": 0,
"value": 0,
"label": "string"
}
]
}
]
}

アクション詳細項目登録

アクション詳細項目を追加します

Authorizations:

X-Api-Key

Request Body schema: application/json

name required	string 項目名
itemKey	string 項目キー。API指定用の任意のキーを指定できます。省略した場合、自動的に一意となる値が設定されます。
itemType required	string アクション詳細項目タイプ。以下のいずれかになります。 text: テキスト single_select: 単一選択
actionCustomItemOptions	Array of objects 選択肢一覧。`itemType` が `single_select` の場合の選択肢定義を設定します。この一覧で指定した通りの並び順で登録されます。
before	string 指定した項目キーの手前に項目を追加します。指定がない場合は最後に追加されます。

Responses

201

Created

400

Bad Request

500

Internal Server Error

post /action_custom_items

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/action_custom_items

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"itemKey": "string",
"itemType": "string",
"actionCustomItemOptions": 
[
{"value": 0,
"label": "string"
}
],
"before": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"actionCustomItemOptions": 
[
{"id": 0,
"value": 0,
"label": "string"
}
]
}

アクション詳細項目更新

アクション詳細項目を更新

Authorizations:

X-Api-Key

path Parameters

item_key

required

string

項目キー

Request Body schema: application/json

name	string 項目名
newItemKey	string 新しい項目キー項目キーを変更した場合、元の項目キーの値を前提とした処理が動作しなくなる可能性があります。
actionCustomItemOptions	Array of objects 選択肢一覧。この一覧で指定した通りの並び順で登録されます。
delete	boolean 削除する場合は true を指定してください

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

patch /action_custom_items/{item_key}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/action_custom_items/{item_key}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"newItemKey": "string",
"actionCustomItemOptions": 
[
{"value": 0,
"newValue": "string",
"delete": true,
"label": "string"
}
],
"delete": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"actionCustomItemOptions": 
[
{"id": 0,
"value": 0,
"label": "string"
}
]
}

アクション詳細項目削除

アクション詳細項目を削除

Authorizations:

X-Api-Key

path Parameters

item_key

required

string

項目キー

Responses

200

404

Not Found

500

Internal Server Error

delete /action_custom_items/{item_key}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/action_custom_items/{item_key}

取引先設定(CustomerSetting)

取引先設定

取引先設定の取得

Authorizations:

X-Api-Key

Responses

200

500

Internal Server Error

get /customer_setting

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customer_setting

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"customerCustomItems": 
[
{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": 0,
"customItemOptions": 
[
{"id": 0,
"value": 0,
"label": "string"
}
]
}
]
}

取引先(Customers)

取引先情報リスト

取引先の情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 指定した文字列と取引先名が部分一致する取引先を検索します。
sort	string 並び順ソート可能 `updatedAt`、`createdAt`
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 更新日時による検索範囲(開始) ex) `2018-04-01T10:30:00`
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 更新日時による検索範囲(終了) ex) `2018-04-01T10:30:00`
page	integer ページ

Responses

200

500

Internal Server Error

get /customers

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"customers": 
[
{"id": 0,
"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
]
}
]
}
]
}

取引先情報登録

取引先情報を新規に登録します
各種IDは、取引先設定で確認できます。

Authorizations:

X-Api-Key

Request Body schema: application/json

name required	string 取引先名
address	string 住所
telNo	string 電話番号
webUrl	string URL
employee	integer 従業員数
capital	integer 資本金
closingMonth	integer [ 1 .. 12 ] 決算月（1〜12）
ownerRoleId	integer 所有ロールID。`0` を指定するとロール未指定になります。
customerCustoms	Array of objects 取引先詳細項目

Responses

201

Created

500

Internal Server Error

post /customers

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"closingMonth": 1,
"ownerRoleId": 0,
"customerCustoms": 
[
{"customerCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
]
}
]
}

取引先情報検索

取引先情報を検索します。

field の reference (参照先関連オブジェクト) 指定には対応していません。

Authorizations:

X-Api-Key

Request Body schema: application/json

filter required	object 絞り込み条件
sort	object 並び替え条件。詳細項目、関連オブジェクトの項目指定の並び替えには対応していません。
page	integer ページ

Responses

200

400

検索条件が不正

500

Internal Server Error

post /customers/search

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/search

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"filter": 
{"compositeFilter": 
{"logicalOperator": "AND",
"subFilters": 
[
{"compositeFilter": { },
"valueFilter": 
{"field": 
{"reference": "string",
"name": "string",
"customItemId": 0,
"itemKey": "string"
},
"comparisonOperator": "=",
"value": 
{"stringValue": "string",
"integerValue": 0,
"decimalValue": 0,
"datetimeValue": "2018-04-01T10:30:00"
}
}
}
]
}
},
"sort": 
{"field": 
{"name": "string"
},
"order": "ASC"
},
"page": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"customers": 
[
{"id": 0,
"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
]
}
]
}
]
}

取引先情報

取引先情報を取得

Authorizations:

X-Api-Key

path Parameters

required

integer

取引先ID

Responses

200

404

Not Found

500

Internal Server Error

get /customers/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
]
}
]
}

取引先情報更新

取引先情報を更新
各種IDは、取引先設定で確認できます。

Authorizations:

X-Api-Key

path Parameters

required

integer

取引先ID

Request Body schema: application/json

name	string 取引先名
address	string 住所
telNo	string 電話番号
webUrl	string URL
employee	integer 従業員数
capital	integer 資本金
closingMonth	integer [ 1 .. 12 ] 決算月（1〜12）
ownerRoleId	integer 所有ロールID。`0` を指定するとロール未指定になります。
customerCustoms	Array of objects 取引先詳細項目

Responses

200

400

Bad Request

500

Internal Server Error

patch /customers/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"closingMonth": 1,
"ownerRoleId": 0,
"customerCustoms": 
[
{"customerCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
]
}
]
}

取引先情報削除

取引先情報を削除
取引先に紐づく案件、アクション、コンタクトは全て削除されます

Authorizations:

X-Api-Key

path Parameters

required

integer

取引先ID

Responses

200

404

Not Found

500

Internal Server Error

delete /customers/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{id}

取引先一括登録

取引先を一括登録します
一度に登録可能な上限は1000件です
各種IDは、取引先設定で確認できます
このAPIを使って登録した場合、Mazrica登録企業との自動紐付けは行われません
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

customers

Array of objects

Responses

200

全件登録成功した場合のみ、このコードが返ります

400

1件でも登録エラーとなった場合、このコードが返ります
1件でも登録エラーとなった場合、全てのデータが登録されません

500

Internal Server Error

post /customers/bulk

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/bulk

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customers": 
[
{"name": "string",
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"closingMonth": 1,
"ownerRoleId": 0,
"customerCustoms": 
[
{"customerCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[0
]

取引先アクション(CustomerActions)

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

アクション情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

path Parameters

customerId

required

integer

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

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

query Parameters

sort	string 並び順ソート可能 `startDatetime`
startDatetime	string <date-time> Example: startDatetime=2018-04-01T10:30:00 開始日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
endDatetime	string <date-time> Example: endDatetime=2018-04-01T10:30:00 終了日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00 登録日時開始時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00 登録日時終了時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 最終更新日時開始時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 最終更新日時終了時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
users	Array of objects アクション担当者、その他の担当者を検索します。 GETパラメータで指定する場合、以下の形式で指定します。 `?users[]id=1&users[]id=2`
pattern	integer アクションの種別
active	boolean true:予定 false:完了
page	integer ページ

Responses

200

500

Internal Server Error

get /customers/{customerId}/actions

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{customerId}/actions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"actions": 
[
{"id": 0,
"pattern": 
{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}
]
}

取引先アクション登録

アクションを新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

startDatetime required	string <date-time> 開始日時
endDatetime required	string <date-time> 終了日時
creator required	object アクション担当者ID
invitees	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
pattern required	object
contacts	Array of objects アクションコンタクト
actionCustoms	Array of objects アクション詳細項目一覧

Responses

201

Created

400

Bad Request

404

Not Found

500

Internal Server Error

post /customers/{customerId}/actions

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{customerId}/actions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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
},
"contacts": 
[
{"id": 0
}
],
"actionCustoms": 
[
{"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}

取引先アクション情報

アクション情報を取得

Authorizations:

X-Api-Key

path Parameters

customerId required	integer 取引先ID
id required	integer アクションID

query Parameters

include_files

integer

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

Responses

200

404

Not Found

500

Internal Server Error

get /customers/{customerId}/actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{customerId}/actions/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
],
"files": 
[
{"name": "string",
"mimeType": "string",
"url": "string"
}
]
}

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

アクション情報を更新

Authorizations:

X-Api-Key

path Parameters

customerId required	integer 取引先ID
id required	integer アクションID

Request Body schema: application/json

startDatetime	string <date-time> 開始日時
endDatetime	string <date-time> 終了日時
creator	object アクション担当者ID
invitees	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
pattern	object
contacts	Array of objects アクションコンタクト
actionCustoms	Array of objects アクション詳細項目一覧

Responses

200

400

Bad Request

500

Internal Server Error

patch /customers/{customerId}/actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{customerId}/actions/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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
},
"contacts": 
[
{"id": 0
}
],
"actionCustoms": 
[
{"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}

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

アクション情報を削除

Authorizations:

X-Api-Key

path Parameters

customerId required	integer 取引先ID
id required	integer アクションID

Responses

200

404

Not Found

500

Internal Server Error

delete /customers/{customerId}/actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/{customerId}/actions/{id}

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

取引先アクションを一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

actions

Array of objects

Responses

200

全件登録成功した場合のみ、このコードが返ります

400

1件でも登録エラーとなった場合、このコードが返ります
1件でも登録エラーとなった場合、全てのデータが登録されません

500

Internal Server Error

post /customers/actions/bulk

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/customers/actions/bulk

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"actions": 
[
{"customer": 
{"id": 0
},
"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
},
"contacts": 
[
{"id": 0
}
],
"actionCustoms": 
[
{"itemKey": "string",
"value": "string"
}
],
"files": 
[
{"name": "string",
"path": "string"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[0
]

案件設定(DealSetting)

案件タイプリスト

案件タイプのリスト取得

Authorizations:

X-Api-Key

Responses

200

500

Internal Server Error

get /deal_setting/deal_types

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deal_setting/deal_types

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string"
}

案件タイプ設定情報

案件タイプ設定情報

Authorizations:

X-Api-Key

path Parameters

required

integer

案件タイプID

Responses

200

404

Not Found

500

Internal Server Error

get /deal_setting/deal_types/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deal_setting/deal_types/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"phases": 
[
{"id": 0,
"name": "string",
"status": 1
}
],
"products": 
[
{"id": 0,
"name": "string"
}
],
"probabilities": 
[
{"id": 0,
"name": "string"
}
],
"channels": 
[
{"id": 0,
"name": "string"
}
],
"endPhaseReasons": 
[
{"id": 0,
"name": "string"
}
],
"actionsPurposes": 
[
{"id": 0,
"name": "string",
"pattern": 0,
"patternName": "string"
}
],
"dealCustomItems": 
[
{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": null,
"orderNum": "string",
"customItemOptions": 
[
{"id": 0,
"value": "string",
"label": "string"
}
]
}
],
"dealProductDetailTypes": 
[
{"id": 0,
"name": "string",
"unit": "string",
"price": 0,
"billingType": 
{"id": 1,
"key": "lump",
"name": "一括"
},
"roundType": 
{"id": 1,
"key": "round_down",
"name": "切り捨て"
},
"memo": "string"
}
]
}

案件(Deals)

案件情報リスト

案件情報のリスト取得
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 指定した文字列と取引先名、または案件名が部分一致する案件を検索します。
dealTypeId	number 案件タイプID
sort	string 並び順ソート可能 `updatedAt`、`createdAt`
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 更新日時による検索範囲（開始） ex) `2018-04-01T10:30:00`
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 更新日時による検索範囲指定（終了） ex) `2018-04-01T10:30:00`
page	integer ページ
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。

Responses

200

500

Internal Server Error

get /deals

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"deals": 
[
{"id": 0,
"name": "string",
"dealCode": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": 
{"id": 0,
"name": "string"
},
"endPhaseReasons": 
[
{"id": 0,
"name": "string"
}
],
"customer": 
{"id": 0,
"name": "string"
},
"phase": 
{"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": 
[
{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": 
{"id": 0,
"name": "string"
},
"probability": 
{"id": 0,
"name": "string"
},
"channel": 
{"id": 0,
"name": "string"
},
"user": 
{"id": 0,
"name": "string"
},
"dealCustoms": 
[
{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"calculationResult": 0,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": 
[
{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": 
{"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
]
}
]
}

案件情報登録

案件情報を新規に登録します
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

Request Body schema: application/json

dealType required	object 案件タイプ
name required	string 案件名
amount	integer 契約金額
expectedContractDate required	string <date> 契約予定日
reason	string 最終停止理由
endPhaseReasonIds	Array of integers 最終停止理由ID 配列
dealProductDetails	Array of objects 商品内訳
customer required	object 取引先
phase required	object フェーズ
product required	object 商品
probability required	object 契約確度
channel required	object チャネル
user required	object ユーザー
dealCustoms	Array of objects 案件詳細項目

Responses

201

Created

500

Internal Server Error

post /deals

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"dealType": 
{"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": 
[0
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
],
"customer": 
{"id": 0
},
"phase": 
{"id": 0
},
"product": 
{"id": 0
},
"probability": 
{"id": 0
},
"channel": 
{"id": 0
},
"user": 
{"id": 0
},
"dealCustoms": 
[
{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"dealCode": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": 
{"id": 0,
"name": "string"
},
"endPhaseReasons": 
[
{"id": 0,
"name": "string"
}
],
"customer": 
{"id": 0,
"name": "string"
},
"phase": 
{"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": 
[
{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": 
{"id": 0,
"name": "string"
},
"probability": 
{"id": 0,
"name": "string"
},
"channel": 
{"id": 0,
"name": "string"
},
"user": 
{"id": 0,
"name": "string"
},
"dealCustoms": 
[
{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"calculationResult": 0,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": 
[
{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": 
{"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
]
}

案件情報

案件情報を取得

Authorizations:

X-Api-Key

path Parameters

required

integer

案件ID

Responses

200

404

Not Found

500

Internal Server Error

get /deals/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"dealCode": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": 
{"id": 0,
"name": "string"
},
"endPhaseReasons": 
[
{"id": 0,
"name": "string"
}
],
"customer": 
{"id": 0,
"name": "string"
},
"phase": 
{"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": 
[
{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": 
{"id": 0,
"name": "string"
},
"probability": 
{"id": 0,
"name": "string"
},
"channel": 
{"id": 0,
"name": "string"
},
"user": 
{"id": 0,
"name": "string"
},
"dealCustoms": 
[
{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"calculationResult": 0,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": 
[
{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": 
{"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
]
}

案件情報更新

案件情報を更新
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

path Parameters

required

integer

案件ID

Request Body schema: application/json

dealType	object 案件タイプ
name	string 案件名
amount	integer 契約金額
expectedContractDate	string <date> 契約予定日
reason	string 最終停止理由
endPhaseReasonIds	Array of integers 最終停止理由ID 配列
dealProductDetails	Array of objects 商品内訳
customer	object 取引先
phase	object フェーズ
product	object 商品
probability	object 契約確度
channel	object チャネル
user	object ユーザー
dealCustoms	Array of objects 案件詳細項目

Responses

200

400

Bad Request

500

Internal Server Error

patch /deals/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"dealType": 
{"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": 
[0
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
],
"customer": 
{"id": 0
},
"phase": 
{"id": 0
},
"product": 
{"id": 0
},
"probability": 
{"id": 0
},
"channel": 
{"id": 0
},
"user": 
{"id": 0
},
"dealCustoms": 
[
{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"dealCode": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": 
{"id": 0,
"name": "string"
},
"endPhaseReasons": 
[
{"id": 0,
"name": "string"
}
],
"customer": 
{"id": 0,
"name": "string"
},
"phase": 
{"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": 
[
{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": 
{"id": 0,
"name": "string"
},
"probability": 
{"id": 0,
"name": "string"
},
"channel": 
{"id": 0,
"name": "string"
},
"user": 
{"id": 0,
"name": "string"
},
"dealCustoms": 
[
{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"calculationResult": 0,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": 
[
{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": 
{"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
]
}

案件情報削除

案件情報を削除
案件に紐づく案件、アクションは全て削除されます

Authorizations:

X-Api-Key

path Parameters

required

integer

案件ID

Responses

200

404

Not Found

500

Internal Server Error

delete /deals/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals/{id}

案件一括登録

案件を一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

path Parameters

deal_type_id

required

integer

案件タイプID

Request Body schema: application/json

deals

Array of objects

Responses

200

全件登録成功した場合のみ、このコードが返ります

400

1件でも登録エラーとなった場合、このコードが返ります
1件でも登録エラーとなった場合、全てのデータが登録されません

500

Internal Server Error

post /deal_types/{deal_type_id}/deals/bulk

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deal_types/{deal_type_id}/deals/bulk

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"deals": 
[
{"dealType": 
{"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": 
[0
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
],
"customer": 
{"id": 0
},
"phase": 
{"id": 0
},
"product": 
{"id": 0
},
"probability": 
{"id": 0
},
"channel": 
{"id": 0
},
"user": 
{"id": 0
},
"dealCustoms": 
[
{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[0
]

案件一括更新

案件を一括更新します
一度に更新可能な上限は1000件です
このAPIを使って更新した場合、監査ログは記録されません
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

path Parameters

deal_type_id

required

integer

案件タイプID

Request Body schema: application/json

deals

Array of objects

Responses

200

全件登録成功した場合のみ、このコードが返ります

400

1件でも登録エラーとなった場合、このコードが返ります
1件でも登録エラーとなった場合、全てのデータが登録されません

500

Internal Server Error

patch /deal_types/{deal_type_id}/deals/bulk

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deal_types/{deal_type_id}/deals/bulk

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"deals": 
[
{"id": 0,
"dealType": 
{"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": 
[0
],
"dealProductDetails": 
[
{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string"
}
],
"customer": 
{"id": 0
},
"phase": 
{"id": 0
},
"product": 
{"id": 0
},
"probability": 
{"id": 0
},
"channel": 
{"id": 0
},
"user": 
{"id": 0
},
"dealCustoms": 
[
{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": "string",
"messages": 
["string"
],
"bulkErrors": 
[
{"index": 0,
"massages": 
["string"
]
}
]
}

案件コンタクト(DealsContacts)

案件コンタクトリスト

案件情報を取得

Authorizations:

X-Api-Key

path Parameters

dealId

required

integer

案件ID

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

get /deals/{dealId}/contacts

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals/{dealId}/contacts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
]
}

案件コンタクト情報登録

案件にコンタクトを紐づけます

Authorizations:

X-Api-Key

path Parameters

dealId required	integer 案件ID
id required	integer コンタクトID

Responses

201

Created

400

Bad Request

404

Not Found

500

Internal Server Error

post /deals/{dealId}/contacts/{contactId}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals/{dealId}/contacts/{contactId}

案件コンタクト情報削除

案件からコンタクトを削除します
コンタクト自体は削除されません

Authorizations:

X-Api-Key

path Parameters

dealId required	integer 案件ID
id required	integer コンタクトID

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

delete /deals/{dealId}/contacts/{contactId}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/deals/{dealId}/contacts/{contactId}

案件アクション(Actions)

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

アクション情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

sort	string 並び順ソート可能 `startDatetime`
startDatetime	string <date-time> Example: startDatetime=2018-04-01T10:30:00 開始日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
endDatetime	string <date-time> Example: endDatetime=2018-04-01T10:30:00 終了日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00 登録日時開始時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00 登録日時終了時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 最終更新日時開始時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 最終更新日時終了時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
users	Array of objects アクション担当者、その他の担当者を検索します。 GETパラメータで指定する場合、以下の形式で指定します。 `?users[]id=1&users[]id=2`
purpose	integer アクションの目的
active	boolean true:予定 false:完了
dealId	integer 案件IDを指定して検索します。
page	integer ページ

Responses

200

500

Internal Server Error

get /actions

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/actions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"actions": 
[
{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"purpose": 
{"id": 0,
"name": "string"
},
"deal": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}
]
}

案件アクション登録

アクションを新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

startDatetime required	string <date-time> 開始日時
endDatetime required	string <date-time> 終了日時
creator required	object アクション担当者ID
invitees	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
purpose required	object アクションの目的アクションの種別は目的に対応する値が自動的に設定されます。目的IDは、案件タイプ設定情報で確認できます
deal required	object 案件ID
contacts	Array of objects アクションコンタクト
actionCustoms	Array of objects アクション詳細項目一覧

Responses

201

Created

400

Bad Request

404

Not Found

500

Internal Server Error

post /actions

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/actions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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,
"purpose": 
{"id": 0
},
"deal": 
{"id": 0
},
"contacts": 
[
{"id": 0
}
],
"actionCustoms": 
[
{"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"purpose": 
{"id": 0,
"name": "string"
},
"deal": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}

案件アクション情報

アクション情報を取得

Authorizations:

X-Api-Key

path Parameters

required

integer

アクションID

query Parameters

include_files

integer

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

Responses

200

404

Not Found

500

Internal Server Error

get /actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/actions/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"purpose": 
{"id": 0,
"name": "string"
},
"deal": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
],
"files": 
[
{"name": "string",
"mimeType": "string",
"url": "string"
}
]
}

案件アクション情報更新

アクション情報を更新

Authorizations:

X-Api-Key

path Parameters

required

integer

アクションID

Request Body schema: application/json

startDatetime required	string <date-time> 開始日時
endDatetime required	string <date-time> 終了日時
creator required	object アクション担当者ID
invitees	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
purpose required	object アクションの目的アクションの種別は目的に対応する値が自動的に設定されます。目的IDは、案件タイプ設定情報で確認できます
deal required	object 案件ID
contacts	Array of objects アクションコンタクト
actionCustoms	Array of objects アクション詳細項目一覧

Responses

200

400

Bad Request

500

Internal Server Error

patch /actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/actions/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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,
"purpose": 
{"id": 0
},
"deal": 
{"id": 0
},
"contacts": 
[
{"id": 0
}
],
"actionCustoms": 
[
{"itemKey": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"purpose": 
{"id": 0,
"name": "string"
},
"deal": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}

案件アクション情報削除

アクション情報を削除

Authorizations:

X-Api-Key

path Parameters

required

integer

アクションID

Responses

200

404

Not Found

500

Internal Server Error

delete /actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/actions/{id}

案件アクション一括登録

案件アクションを一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

dealTypeId	integer 案件タイプID 指定した一つの案件タイプのアクションのみ一括作成可能です。案件タイプを跨った一括登録には対応しておりません。
actions	Array of objects

Responses

200

全件登録成功した場合のみ、このコードが返ります

400

1件でも登録エラーとなった場合、このコードが返ります
1件でも登録エラーとなった場合、全てのデータが登録されません

500

Internal Server Error

post /actions/bulk

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/actions/bulk

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"dealTypeId": 0,
"actions": 
[
{"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,
"purpose": 
{"id": 0
},
"deal": 
{"id": 0
},
"contacts": 
[
{"id": 0
}
],
"actionCustoms": 
[
{"itemKey": "string",
"value": "string"
}
],
"files": 
[
{"name": "string",
"path": "string"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[0
]

コンタクト設定(ContactSetting)

コンタクト設定

コンタクト設定の取得

Authorizations:

X-Api-Key

Responses

200

500

Internal Server Error

get /contact_setting

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contact_setting

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"contactCustomItems": 
[
{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": 0,
"customItemOptions": 
[
{"id": 0,
"value": 0,
"label": "string"
}
]
}
]
}

コンタクト(Contacts)

コンタクト情報リスト

コンタクトの情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 指定した文字列と取引先名、コンタクト名、またはメールアドレスが部分一致するコンタクトを検索します。
sort	string 並び順ソート可能 `updatedAt`、`createdAt`
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 更新日時による検索範囲(開始) ex) `2018-04-01T10:30:00`
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 更新日時による検索範囲(終了) ex) `2018-04-01T10:30:00`
page	integer ページ
phoneNumber	string Example: phoneNumber=03-1111-2222 固定電話番号、携帯電話番号による検索ハイフン市外局番検索可能 ex) `03-1111-2222` ex) `0311112222` ex) `04992(0)1111` ex) `049920局1111`

Responses

200

500

Internal Server Error

get /contacts

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
]

コンタクト情報登録

コンタクト情報を新規に登録します
登録後のコンタクト情報をレスポンスとして返します

Authorizations:

X-Api-Key

Request Body schema: application/json

name required	string コンタクト名
email	string Nullable メールアドレス
tel	string Nullable 電話番号
mobileTel	string Nullable 携帯電話番号
address	string Nullable 住所
dept	string Nullable 部署
position	string Nullable 役職
memo	string Nullable メモ
customer	object Nullable 取引先
contactCustoms	Array of objects コンタクト詳細項目
lifecycleStages	Array of objects

Responses

201

Created

500

Internal Server Error

post /contacts

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"customer": 
{"id": 0
},
"contactCustoms": 
[
{"contactCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}

コンタクト情報検索

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

field の reference (参照先関連オブジェクト) として以下を指定できます。
- customer (取引先)

Authorizations:

X-Api-Key

Request Body schema: application/json

filter required	object 絞り込み条件
sort	object 並び替え条件。詳細項目、関連オブジェクトの項目指定の並び替えには対応していません。
page	integer ページ

Responses

200

400

検索条件が不正

500

Internal Server Error

post /contacts/search

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/search

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"filter": 
{"compositeFilter": 
{"logicalOperator": "AND",
"subFilters": 
[
{"compositeFilter": { },
"valueFilter": 
{"field": 
{"reference": "string",
"name": "string",
"customItemId": 0,
"itemKey": "string"
},
"comparisonOperator": "=",
"value": 
{"stringValue": "string",
"integerValue": 0,
"decimalValue": 0,
"datetimeValue": "2018-04-01T10:30:00"
}
}
}
]
}
},
"sort": 
{"field": 
{"name": "string"
},
"order": "ASC"
},
"page": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
]
}

コンタクト情報

コンタクト情報を取得

Authorizations:

X-Api-Key

path Parameters

required

integer

コンタクトID

Responses

200

404

Not Found

500

Internal Server Error

get /contacts/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}

コンタクト情報更新

コンタクト情報を更新

Authorizations:

X-Api-Key

path Parameters

required

integer

コンタクトID

Request Body schema: application/json

name	string コンタクト名
email	string Nullable メールアドレス
tel	string Nullable 電話番号
mobileTel	string Nullable 携帯電話番号
address	string Nullable 住所
dept	string Nullable 部署
position	string Nullable 役職
memo	string Nullable メモ
customer	object Nullable 取引先
contactCustoms	Array of objects コンタクト詳細項目
lifecycleStages	Array of objects

Responses

200

400

Bad Request

500

Internal Server Error

patch /contacts/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"customer": 
{"id": 0
},
"contactCustoms": 
[
{"contactCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": 1234.56,
"selectedValue": 1,
"selectedValues": 
[1,
2,
3
],
"selectedOptions": 
[
{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"lifecycleStages": 
[
{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}

コンタクト情報削除

コンタクト情報を削除

Authorizations:

X-Api-Key

path Parameters

required

integer

コンタクトID

Responses

200

404

Not Found

500

Internal Server Error

delete /contacts/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{id}

コンタクトアクション(ContactActions)

コンタクトアクション情報リスト

アクション情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

path Parameters

contactId

required

integer

コンタクトIDを指定してアクションを検索します。

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

また、data_typeを指定することで、アクションの種類を絞り込むことも可能です。

data_type: 0 → コンタクトが紐付いている案件アクション

data_type: 1 → コンタクトアクション

query Parameters

sort	string 並び順ソート可能 `startDatetime`
startDatetime	string <date-time> Example: startDatetime=2018-04-01T10:30:00 開始日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
endDatetime	string <date-time> Example: endDatetime=2018-04-01T10:30:00 終了日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00 登録日時開始時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00 登録日時終了時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 最終更新日時開始時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 最終更新日時終了時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
users	Array of objects アクション担当者、その他の担当者を検索します。 GETパラメータで指定する場合、以下の形式で指定します。 `?users[]id=1&users[]id=2`
pattern	integer アクションの種別
active	boolean true:予定 false:完了
dataType	integer コンタクトの種類: `0` - 案件アクション `1` - コンタクトアクション
page	integer ページ

Responses

200

500

Internal Server Error

get /contacts/{contactId}/actions

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"actions": 
[
{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"dataType": 0,
"deal": 
{"id": 0,
"name": "string"
},
"contact": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}
]
}

コンタクトアクション登録

アクションを新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

startDatetime required	string <date-time> 開始日時
endDatetime required	string <date-time> 終了日時
creator required	object アクション担当者ID
invitees	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
pattern required	object
actionCustoms	Array of objects アクション詳細項目一覧

Responses

201

Created

400

Bad Request

404

Not Found

500

Internal Server Error

post /contacts/{contactId}/actions

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"dataType": 0,
"deal": 
{"id": 0,
"name": "string"
},
"contact": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}

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

アクション情報を取得

Authorizations:

X-Api-Key

path Parameters

contactId required	integer コンタクトID
id required	integer アクションID

query Parameters

include_files

integer

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

Responses

200

404

Not Found

500

Internal Server Error

get /contacts/{contactId}/actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"dataType": 0,
"deal": 
{"id": 0,
"name": "string"
},
"contact": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
],
"files": 
[
{"name": "string",
"mimeType": "string",
"url": "string"
}
]
}

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

アクション情報を更新

Authorizations:

X-Api-Key

path Parameters

contactId required	integer コンタクトID
id required	integer アクションID

Request Body schema: application/json

startDatetime	string <date-time> 開始日時
endDatetime	string <date-time> 終了日時
creator	object アクション担当者ID
invitees	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
pattern	object
actionCustoms	Array of objects アクション詳細項目一覧

Responses

200

400

Bad Request

500

Internal Server Error

patch /contacts/{contactId}/actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"pattern": 
{"id": 0,
"name": "string"
},
"dataType": 0,
"deal": 
{"id": 0,
"name": "string"
},
"contact": 
{"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": 
{"id": 0,
"name": "string"
},
"invitees": 
[
{"id": 0,
"name": "string"
}
],
"actionCustoms": 
[
{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"selectedValue": 1
}
]
}

コンタクトアクション情報削除

アクション情報を削除

Authorizations:

X-Api-Key

path Parameters

contactId required	integer コンタクトID
id required	integer アクションID

Responses

200

404

Not Found

500

Internal Server Error

delete /contacts/{contactId}/actions/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions/{id}

コンタクトアクション一括登録

コンタクトアクションを一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

actions

Array of objects

Responses

200

全件登録成功した場合のみ、このコードが返ります

400

1件でも登録エラーとなった場合、このコードが返ります
1件でも登録エラーとなった場合、全てのデータが登録されません

500

Internal Server Error

post /contacts/actions/bulk

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/contacts/actions/bulk

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"actions": 
[
{"contact": 
{"id": 0
},
"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"
}
],
"files": 
[
{"name": "string",
"path": "string"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[0
]

ライフサイクルステージ設定(LifecycleStageSetting)

ライフサイクルステージを利用可能な契約プランのお客様のみ実行可能です。

ライフサイクルステージ設定

ライフサイクルステージ設定の取得

Authorizations:

X-Api-Key

Responses

200

500

Internal Server Error

get /lifecycle_stage_setting

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/lifecycle_stage_setting

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"lifecycleStageTypes": 
[
{"id": 0,
"name": "string",
"lifecycleStages": 
[
{"id": 0,
"name": "string"
}
]
}
]
}

カスタムオブジェクト設定(CustomObjectSetting)

カスタムオブジェクトを利用可能な契約プランのお客様のみ実行可能です。

カスタムオブジェクト定義情報リスト

カスタムオブジェクト定義情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 名前が部分一致するカスタムオブジェクト定義を検索します。
page	integer ページ

Responses

200

403

カスタムオブジェクトが利用可能な契約プランではない

500

Internal Server Error

get /custom_object_defs

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}

カスタムオブジェクト定義情報登録

カスタムオブジェクト定義を新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

name required	string カスタムオブジェクト名
enable_bi	boolean BIのデータソースとして使用するかどうか BIが利用可能でない場合、true にすると登録エラーになります。
key required	string カスタムオブジェクト定義キー。API指定用のキーになります。
customObjectItemDefs	Array of objects 項目定義一覧

Responses

201

Created

400

Bad Request

403

カスタムオブジェクトが利用可能な契約プランではない

500

Internal Server Error

post /custom_object_defs

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"enable_bi": true,
"key": "string",
"customObjectItemDefs": 
[
{"name": "string",
"key": "string",
"itemType": "string",
"customObjectOptionDefs": 
[
[
{"key": "string",
"name": "string"
}
]
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}
]
}

カスタムオブジェクト定義情報

カスタムオブジェクト定義情報を取得

Authorizations:

X-Api-Key

path Parameters

key

required

string

カスタムオブジェクト定義キー

Responses

200

400

Bad Request

403

カスタムオブジェクトが利用可能な契約プランではない

500

Internal Server Error

get /custom_object_defs/{key}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{key}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}
]
}

カスタムオブジェクト定義情報更新

カスタムオブジェクト定義情報を更新

Authorizations:

X-Api-Key

path Parameters

key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

name	string カスタムオブジェクト名
enable_bi	boolean BIのデータソースとして使用するかどうか BIが利用可能でない場合、true にすると登録エラーになります。
newKey	string 新しい定義キーを指定します。
customObjectItemDefs	Array of objects 項目定義一覧

Responses

200

400

Bad Request

403

カスタムオブジェクトが利用可能な契約プランではない

500

Internal Server Error

patch /custom_object_defs/{key}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{key}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"enable_bi": true,
"newKey": "string",
"customObjectItemDefs": 
[
{"key": "string",
"delete": true,
"name": "string",
"newKey": "string",
"customObjectOptionDefs": 
[
[
{"key": "string",
"name": "string",
"newKey": "string",
"delete": true
}
]
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}
]
}

カスタムオブジェクト定義情報削除

カスタムオブジェクト定義情報を削除

Authorizations:

X-Api-Key

path Parameters

key

required

string

カスタムオブジェクト定義キー

Responses

200

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

delete /custom_object_defs/{key}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{key}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": "string",
"messages": 
["string"
]
}

カスタムオブジェクト項目登録

カスタムオブジェクト定義に項目を追加します

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

name required	string 項目名
key required	string 項目キー。API指定用のキーになります。
itemType required	string text: 文字列タイプ date: 日付タイプ number: 整数タイプ decimal_number: 小数タイプ single_select: 単一選択タイプ multi_select: 複数選択タイプ
customObjectOptionDefs	Array of Array of objects 選択肢定義一覧
before	string 指定した項目キーの手前に項目を追加します。指定がない場合は最後に追加されます。

Responses

201

Created

400

Bad Request

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

post /custom_object_defs/{custom_object_def_key}/custom_object_item_defs

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_object_item_defs

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"key": "string",
"itemType": "string",
"customObjectOptionDefs": 
[
[
{"key": "string",
"name": "string"
}
]
],
"before": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"key": "string",
"name": "string",
"itemType": "string",
"customObjectOptionDefs": 
[
{"key": "string",
"name": "string"
}
]
}

カスタムオブジェクト項目更新

カスタムオブジェクト項目を更新

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
key required	string 項目キー

Request Body schema: application/json

name	string 項目名
newKey	string 新しい項目キーを指定します。
customObjectOptionDefs	Array of Array of objects 選択肢定義一覧
delete	boolean 削除する場合は true を指定してください

Responses

200

400

Bad Request

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

patch /custom_object_defs/{custom_object_def_key}/custom_object_item_defs/{key}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_object_item_defs/{key}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"newKey": "string",
"customObjectOptionDefs": 
[
[
{"key": "string",
"name": "string",
"newKey": "string",
"delete": true
}
]
],
"delete": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"key": "string",
"name": "string",
"itemType": "string",
"customObjectOptionDefs": 
[
{"key": "string",
"name": "string"
}
]
}

カスタムオブジェクト項目削除

カスタムオブジェクト項目を削除

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
key required	string 項目キー

Responses

200

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

delete /custom_object_defs/{custom_object_def_key}/custom_object_item_defs/{key}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_object_item_defs/{key}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": "string",
"messages": 
["string"
]
}

カスタムオブジェクト(CustomObjects)

カスタムオブジェクトを利用可能な契約プランのお客様のみ実行可能です。

カスタムオブジェクト情報リスト

カスタムオブジェクト情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

query Parameters

createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00+900 作成日時による検索範囲（開始）
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00+900 作成日時による検索範囲指定（終了）
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00+900 更新日時による検索範囲（開始）
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00+900 更新日時による検索範囲指定（終了）
sort	string 並び順ソート可能 `startDatetime`
page	integer ページ

Responses

200

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

get /custom_object_defs/{custom_object_def_key}/custom_objects

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_objects

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"totalCount": 0,
"page": 0,
"customObjects": 
[
{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null
}
]
}

カスタムオブジェクト情報登録

カスタムオブジェクトを新規に登録します

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

カスタムオブジェクト項目

any

カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。

項目タイプごとに以下の値を設定してください。

文字列タイプ(text)
- type: string
日付タイプ(date)
- type: string
- ISO 8601形式文字列
- ex) 2023-04-22T00:02:03+09:00
整数タイプ(number)
- type: integer
小数タイプ(decimal_number)
- type: string
単一選択タイプ(single_select)
- type: string
- 選択肢キー
複数選択タイプ(multi_select)
- type: Array of string
- 選択肢キーの配列

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名	項目キー	項目タイプ
商品コード	productCode	number
商品名	productName	text

商品コード=123
商品名=サンプル商品

というデータを追加するリクエストペイロードは以下になります。

  {
    "productCode": 123,
    "productName": "サンプル商品"
  }

Responses

201

Created

400

Bad Request

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

post /custom_object_defs/{custom_object_def_key}/custom_objects

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_objects

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"カスタムオブジェクト項目": null
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null
}

カスタムオブジェクト情報

カスタムオブジェクト情報を取得

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
id required	integer カスタムオブジェクトID

Responses

200

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

get /custom_object_defs/{custom_object_def_key}/custom_objects/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_objects/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null
}

カスタムオブジェクト情報更新

カスタムオブジェクト情報を更新

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
id required	integer カスタムオブジェクトID

Request Body schema: application/json

カスタムオブジェクト項目

any

カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。

項目タイプごとに以下の値を設定してください。

文字列タイプ(text)
- type: string
日付タイプ(date)
- type: string
- ISO 8601形式文字列
- ex) 2023-04-22T00:02:03+09:00
整数タイプ(number)
- type: integer
小数タイプ(decimal_number)
- type: string
単一選択タイプ(single_select)
- type: string
- 選択肢キー
複数選択タイプ(multi_select)
- type: Array of string
- 選択肢キーの配列

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名	項目キー	項目タイプ
商品コード	productCode	number
商品名	productName	text

商品コード=123
商品名=サンプル商品

というデータを追加するリクエストペイロードは以下になります。

  {
    "productCode": 123,
    "productName": "サンプル商品"
  }

Responses

200

400

Bad Request

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

patch /custom_object_defs/{custom_object_def_key}/custom_objects/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_objects/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"カスタムオブジェクト項目": null
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null
}

カスタムオブジェクト情報削除

カスタムオブジェクト情報を削除

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
id required	integer カスタムオブジェクトID

Responses

200

403

カスタムオブジェクトが利用可能な契約プランではない

404

Not Found

500

Internal Server Error

delete /custom_object_defs/{custom_object_def_key}/custom_objects/{id}

The Open API Service by Mazrica

https://senses-open-api.mazrica.com/v1/custom_object_defs/{custom_object_def_key}/custom_objects/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": "string",
"messages": 
["string"
]
}