POST/contacts/custom-properties

連絡先カスタムプロパティを登録する。
ドメイン単位で最大 5 個まで登録できる。

Authorization

oauth2

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

Scope

contact

HTTP Request

POSThttps://www.worksapis.com/v1.0/contacts/custom-properties

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
propertyName string 

連絡先カスタムプロパティ名
ドメイン内で一意
英数字とアンダーバー (_) のみ使用可能
英字またはアンダーバー (_) で始める


required
maxLength : 120 
displayName string 

連絡先カスタムプロパティの表示名
ドメイン内で一意


required
maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

連絡先カスタムプロパティの表示名の多言語リスト


minItems : 0 
propertyType string 

連絡先カスタムプロパティタイプ

  • STRING: テキスト
  • LINK: リンク

required
Allowed values : STRING, LINK 
displayOrder integer 

表示順位 (重複許可)
値を指定しない (NULL) 場合、最後尾に指定される。


minimum : 1
format : int32
nullable : true 
multiValued boolean 

複数値の許可
同一の連絡先カスタムプロパティに複数の値を登録できる


default : false 

I18nDisplayName

PropertyTypeDescription
language string 

多言語コード


Allowed values : ja_JP, ko_KR, zh_CN, zh_TW, en_US 
name string 

表示名


maxLength : 20 

Request Example

example

1{2  "domainId": 10000001,3  "propertyName": "ext_id",4  "displayName": "外部 ID",5  "i18nDisplayNames": [6    {7      "language": "ja_JP",8      "name": "外部 ID"9    },10    {11      "language": "en_US",12      "name": "external id"13    }14  ],15  "propertyType": "STRING",16  "displayOrder": 117}

Response

HTTP 201

OK

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32 
customPropertyId string 

カスタムプロパティ ID
登録時に自動発行されるユニーク ID


readOnly : true 
propertyName string 

連絡先カスタムプロパティ名
ドメイン内で一意
英数字とアンダーバー (_) のみ使用可能
英字またはアンダーバー (_) で始める


maxLength : 120 
displayName string 

連絡先カスタムプロパティの表示名
ドメイン内で一意


maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

連絡先カスタムプロパティの表示名の多言語リスト


minItems : 0 
propertyType string 

連絡先カスタムプロパティタイプ

  • STRING: テキスト
  • LINK: リンク

Allowed values : STRING, LINK 
displayOrder integer 

表示順位 (重複許可)
値を指定しない (NULL) 場合、最後尾に指定される


minimum : 1
format : int32
nullable : true 
multiValued boolean 

複数値の許可
同一の連絡先カスタムプロパティに複数の値を登録できる


default : false 

I18nDisplayName

PropertyTypeDescription
language string 

多言語コード


Allowed values : ja_JP, ko_KR, zh_CN, zh_TW, en_US 
name string 

表示名


maxLength : 20 

Response Example

example

1{2  "domainId": 10000001,3  "customPropertyId": "custompi-5ge3-f6d7-ht33-35gr6e465u01",4  "propertyName": "ext_id",5  "displayName": "外部 ID",6  "i18nDisplayNames": [7    {8      "language": "ja_JP",9      "name": "外部 ID"10    },11    {12      "language": "en_US",13      "name": "external id"14    }15  ],16  "propertyType": "STRING",17  "displayOrder": 1,18  "multiValued": false19}

HTTP 400

Bad Request

HTTP 403

Forbidden