crisphive
顧客›顧客の作成

顧客の作成

現在のビジネスに新しい顧客レコードを追加します。住所（street、city、postal_code など）と座標（latitude/longitude）は、ネストされた `address` オブジェクトの配下に指定します。service_area_id には、このビジネスに属する有効なサービスエリアの UUID を指定する必要があります。

引数

▾addressobjectbody任意
郵送先住所と座標です。
citystringbody任意
countrystringbody任意
formattedstringbody任意
latitudenumberbody任意
linestringbody任意
line2stringbody任意
longitudenumberbody任意
postal_codestringbody任意
statestringbody任意
emailstringbody任意
メールアドレスです。省略可能ですが、phone/email の少なくとも一方は必須です。
full_namestringbody必須
顧客の氏名です。必須。最大 255 文字です。
phonestringbody任意
電話番号です。省略可能ですが、phone/email の少なくとも一方は必須です。10〜20 文字です。
preferred_technician_idstringbody任意
この顧客が希望するテクニシャンの UUID です。このビジネスに属している必要があります。
service_area_idstringbody任意
この顧客のサービスエリアの UUID です。このビジネスに属している必要があります。
tierenumbody任意
ロイヤルティティアです。省略した場合は "regular" になります。
uidstringbody任意
この顧客に対するお客様側の外部参照（自社システムの ID）です。省略可能。最大 32 文字です。
POST/v1/customers
curl -X POST "https://api.crisphive.com/v1/customers" \
  -H "Authorization: Bearer chsk_test_4eC8xQ9mZ2pL7Ka0rT" \
  -H "Content-Type: application/json" \
  -d '{
  "address": {
    "city": "San Francisco",
    "country": "US",
    "formatted": "123 Market Street, San Francisco, CA 94103",
    "latitude": 1,
    "line": "123 Market Street",
    "line2": "Suite 200",
    "longitude": 1,
    "postal_code": "94103",
    "state": "CA"
  },
  "email": "jane.doe@example.com",
  "full_name": "Jane Cooper",
  "phone": "+14155550142",
  "preferred_technician_id": "9b2f6c3e-1a4d-4f0a-8f2e-7c5d1b3a9e01",
  "service_area_id": "9b2f6c3e-1a4d-4f0a-8f2e-7c5d1b3a9e01",
  "tier": "regular",
  "uid": "CRM-10293"
}'
リクエストボディ
{
"address": {
"city": ,
"country": ,
"formatted": ,
"latitude": ,
"line": ,
"line2": ,
"longitude": ,
"postal_code": ,
"state":
},
"email": ,
"full_name": ,
"phone": ,
"preferred_technician_id": ,
"service_area_id": ,
"tier": ,
"uid":
}

レスポンス

‹顧客一覧の取得前へ
顧客の削除›次へ