メインコンテンツへスキップ
クライアント作成エンドポイントを使用すると、外部システムからAgencyHandyワークスペースにクライアントを直接追加できます。リードとは異なり、クライアントは注文、請求書、プロジェクトに割り当て可能な完全にオンボードされた連絡先です。CRM、オンボーディングフォーム、またはその他のデータソースから新しいクライアントを同期するためにこのエンドポイントを使用します。
このエンドポイントを使用する前に、入門ガイドを完了してAPIキーと会社IDを取得してください。リード作成エンドポイントとは異なり、クライアントの作成には個別のロールIDの取得ステップは必要ありません。

​
前提条件

  • ✅ ワークスペース設定 → APIキーから生成されたAPIキー
  • ✅ GET {{URL}}/accounts/companiesから取得した会社ID

​
エンドポイント

POST {{URL}}/members/bulk-client

​
ヘッダー

ヘッダー値
x-api-keyあなたのAPIキー
companyIdあなたの会社ID
Content-Typeapplication/json

​
リクエストボディ

リクエストボディはJSON配列です。1回のリクエストで1つ以上のクライアントを作成できます。
​
firstName
string
必須
クライアントの名前。
​
lastName
string
必須
クライアントの姓。
​
email
string
必須
クライアントのメールアドレス。ワークスペース内で一意である必要があります。
​
isConvertedClient
boolean
必須
新規クライアントの場合はfalseに設定します。既存のリードをクライアントに変換する場合はtrueに設定します。
​
status
string
クライアントのステータス。一般的な値：New、Active。省略した場合はNewがデフォルト値となります。
​
contactNo
string
クライアントの電話番号。
​
source
string
このクライアントの獲得方法。値の例：website、referral、social。
​
positionInBoard
number
ボードの列内でのクライアントの位置。デフォルトは1。

​
リクエスト例

cURL
curl --request POST "https://api.agencyhandy.com/members/bulk-client" \
  --header "x-api-key: <YOUR_API_KEY>" \
  --header "companyId: <YOUR_COMPANY_ID>" \
  --header "Content-Type: application/json" \
  --data '[
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1
    }
  ]'

​
成功レスポンス

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
成功時の確認文字列。
​
createdMembers
array
作成されたクライアントオブジェクトの配列。
​
createdMembers[].\_id
string
新しく作成されたクライアントの一意ID。APIを通じてクライアントを注文や請求書に割り当てる際にこのIDを使用します。
​
createdMembers[].name
string
クライアントのフルネーム（firstName + lastName）。
​
createdMembers[].status
string
保存されたクライアントのステータス。
​
createdMembers[].role
string
メンバーに割り当てられたロール — "client"になります。
このエンドポイントのcompanyIdヘッダーでは、IdのIが大文字になっています — companyId — companyid（すべて小文字）を使用する他のエンドポイントとは異なります。認証エラーを避けるため、上記に示された正確な大文字・小文字の表記を使用してください。
配列に複数のクライアントオブジェクトを渡すことで、1回のAPI呼び出しでクライアントを一括作成できます。各オブジェクトには一意のemailアドレスが必要です。重複するメールアドレスはそのエントリに対してバリデーションエラーを引き起こします。