POST/partners/customers

顧客企業を登録する。

注意
productId プロパティには、LINE WORKSサービスの情報のみを含みます。
productId プロパティは、将来の廃止を予定しています。
今後は、商品を指定せずに顧客企業を登録した後で、商品の契約登録 で商品を申し込みます。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner

HTTP Request

POSThttps://www.worksapis.com/v1.0/partners/customers

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domain string 

ドメイン名
文字の英数小文字、ハイフンのみ利用可能 (ハイフン "-" : 最初と最後および連続使用を除く)


required
minLength : 2
maxLength : 22 
productId string 

商品 ID

  • FR : Free
  • STD_T : Standard
  • ADV_T : Advanced

注意
productId は将来の廃止を予定しています。


Allowed values : FR, STD_T, ADV_T 
companyName string 

企業/団体名


required
maxLength : 40 
phoneNumber string 

電話番号
数字および P T - * # + , のみ指定可


required 
timeZone string 

タイムゾーンコード


required 
locale string 

言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_TW, zh_CN 
administrator object (administrator) 
 
partnership object (partnership) 
 

administrator

PropertyTypeDescription
lastName string 

姓
姓、名は合計 80 字まで指定可能。
使用可能な特殊文字: ! @ & ( ) - _ + [ ] { } , .


required
maxLength : 80 
firstName string 

名
姓、名は合計 80 字まで指定可能。
使用可能な特殊文字: ! @ & ( ) - _ + [ ] { } , .

 
password string 

管理者パスワード
「英数字」または「英数字＋特殊文字」の混合で指定可。
3 字以上連続または反復する文字、数字は利用不可能。
BASE64 でエンコードして指定する。


required
minLength : 8
maxLength : 20 
id string 

ユーザー ID
例) test@example.com ならば test のみ指定する。
英数小文字および "."、"-"、"_" のみ使用可 admin および administrator は指定できない


required
minLength : 2
maxLength : 40 
privateEmail string 

個人メールアドレス


required 
cellphone string 

携帯電話番号
数字および P T - * # + , のみ使用可

 
countryCode string 

国家コード
cellphone 指定時に必須。

 

partnership

PropertyTypeDescription
enablePartnerProfileDisplay boolean 

パートナープロフィール表示有効フラグ


default : true 

Request Example

example

1{2  "domain": "example.com",3  "productId": "STD_T",4  "companyName": "ワークスモバイルジャパン株式会社",5  "phoneNumber": "03-0000-0000",6  "timeZone": "Asia/Tokyo",7  "locale": "ja_JP",8  "administrator": {9    "lastName": "ワークス",10    "firstName": "管理者",11    "id": "companyadmin",12    "password": "UGFydG5lcjk4IQ==",13    "privateEmail": "private.works@example.com",14    "cellphone": "090-0000-0000",15    "countryCode": "+81"16  },17  "partnership": {18    "enablePartnerProfileDisplay": true19  }20}

Response

HTTP 201

OK

PropertyTypeDescription
tenantId integer 

テナント ID


required
readOnly : true 
domainId integer 

ドメイン ID


required
readOnly : true 
domain string 

ドメイン名


required 
productId string 

商品 ID

  • FR : Free
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

注意
productId は将来の廃止を予定しています。


Allowed values : FR, STD_T, ADV_T, STD, ADV
nullable : true 
companyName string 

顧客企業/団体名


required 
phoneNumber string 

電話番号


required 
timeZone string 

タイムゾーンコード


required 
locale string 

言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_TW, zh_CN 
enableActiveMxrecord boolean 

MX レコード設定有効フラグ


required 
enableActiveDomain boolean 

ドメイン所有権有効フラグ


required 
domainType string 

ドメインタイプ

  • DOMAIN : ドメイン
  • GROUP : グループ

required
Allowed values : DOMAIN, GROUP 
administrator object (administrator) 

管理者情報

 
partnership object (partnership) 

ドメイン情報

 

administrator

PropertyTypeDescription
lastName string 

姓


required 
firstName string 

名

 
id string 

ユーザー ID


required 
privateEmail string 

個人メールアドレス


required
format : email 
cellphone string 

携帯電話番号

 
countryCode string 

国家コード

 

partnership

PropertyTypeDescription
status string 

パートナー状態

  • TRANSFER_READY : Online Direct からパートナーに転換した後、顧客企業が承認する前の待機状態
  • TERMS_AGREEMENT_READY : 規約に同意する前の状態
  • APPROVED : パートナーシップが締結された状態

Allowed values : TRANSFER_READY, TERMS_AGREEMENT_READY, APPROVED 
customerCode string 

管理用識別コード


maxLength : 200 
enablePartnerProfileDisplay boolean 

パートナープロフィール表示有効フラグ

 
memo string 

メモ


maxLength : 700 
enableDeveloperConsoleAccessControl boolean 

Developer Console のアクセス許可有効フラグ

 
enableAdminConsoleAccessControl boolean 

管理者画面アクセス許可有効フラグ

 
useOptionPlus boolean 

オプションプラス契約済みフラグ (廃止済み。常に true)

 

Response Example

example

1{2  "tenantId": 10000001,3  "domainId": 10000001,4  "domain": "example.com",5  "productId": "STD_T",6  "companyName": "ワークスモバイルジャパン株式会社",7  "phoneNumber": "03-0000-0000",8  "timeZone": "Asia/Tokyo",9  "locale": "ja_JP",10  "enableActiveMxrecord": true,11  "enableActiveDomain": true,12  "domainType": "DOMAIN",13  "administrator": {14    "lastName": "ワークス",15    "firstName": "管理者",16    "id": "companyadmin",17    "privateEmail": "private.works@example.com",18    "cellphone": "090-0000-0000",19    "countryCode": "+81"20  },21  "partnership": {22    "status": "TRANSFER_READY",23    "customerCode": "asd123ada11",24    "enablePartnerProfileDisplay": true,25    "memo": "メモ",26    "enableDeveloperConsoleAccessControl": true,27    "enableAdminConsoleAccessControl": true,28    "useOptionPlus": true29  }30}