PATCH/directory/users/custom-properties/{customPropertyId}

Updates a member custom property of a domain.

Note

  • This API operation cannot update the propertyName, propertyType, and multiValued values.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

directory

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/directory/users/custom-properties/{customPropertyId}

Path Parameters

ParameterTypeDescription
customPropertyId string 

customPropertyId or propertyName


required
example : customfd-fc09-4a57-ab38-03dc6c425e09 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domainId integer 

Domain ID


format : int32 
displayName string 

Custom property display name. It must be unique within a domain.


maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

List of multilingual display names


minItems : 0 
displayOrder integer 

Sort order. Duplicates are allowed. Based on this value, items are sorted in ascending order. If it is not specified (NULL), the custom property is located at the end of the list.


minimum : 1
format : int32
nullable : true 
options array (UserCustomPropertyOption) 

List of options if propertyType is STRING


minItems : 2 
mandatory boolean 

Indicates whether it is mandatory.


default : false 
readAccessType string 

Read permission


default : ALL
Allowed values : ADMIN_AND_SELF, ALL 
writeAccessType string 

Write permission


default : ADMIN
Allowed values : ADMIN, ADMIN_AND_SELF 

I18nDisplayName

PropertyTypeDescription
language string 

Language code


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

Multilingual name


maxLength : 20 

UserCustomPropertyOption

PropertyTypeDescription
optionName string 

Option name
The name can only contain English alphabet, numbers, and underscores ().


maxLength : 100 
displayName string 

Option display name


maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

List of multilingual option display names


minItems : 0 

Request Example

example

1{2  "domainId": 10000001,3  "displayName": "취미(hobby)",4  "mandatory": true,5  "readAccessType": "ADMIN_AND_SELF"6}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

Domain ID


required
format : int32 
customPropertyId string 

Custom property ID. It is automatically assigned.


readOnly : true 
propertyName string 

Custom property name.
It must be unique within a domain. The name can only contain English alphabet, numbers, and underscores (_). It must start with an alphabetic character or underscore (_).


required
maxLength : 120 
displayName string 

Custom property display name
It must be unique within a domain.


required
maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

List of multilingual display names


minItems : 0 
propertyType string 

Custom property type

  • STRING: Text
  • LINK: Hyperlink
  • INTEGER: Number
  • DATE: Date

required
Allowed values : STRING, LINK, INTEGER, DATE 
displayOrder integer 

Sort order. Duplicates are allowed. Based on this value, items are sorted in ascending order. If it is not specified (NULL), the custom property is located at the end of the list.


required
minimum : 1
format : int32
nullable : true 
multiValued boolean 

Indicates whether multiple values can be added for the same custom property.


required
default : false 
options array (UserCustomPropertyOption) 

List of options if propertyType is STRING


minItems : 2 
mandatory boolean 

Indicates whether it is mandatory.


required
default : false 
readAccessType string 

Read permission


required
default : ALL
Allowed values : ADMIN_AND_SELF, ALL 
writeAccessType string 

Write permission


required
default : ADMIN
Allowed values : ADMIN, ADMIN_AND_SELF 

I18nDisplayName

PropertyTypeDescription
language string 

Language code


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

Multilingual name


maxLength : 20 

UserCustomPropertyOption

PropertyTypeDescription
optionName string 

Option name
The name can only contain English alphabet, numbers, and underscores ().


maxLength : 100 
displayName string 

Option display name


maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

List of multilingual option display names


minItems : 0 

Response Example

example

1{2  "domainId": 10000001,3  "customPropertyId": "customfd-fc09-4a57-ab38-03dc6c425e01",4  "propertyName": "string_single_option",5  "displayName": "Hobby",6  "i18nDisplayNames": [7    {8      "language": "ko_KR",9      "name": "취미"10    },11    {12      "language": "en_US",13      "name": "Hobby"14    }15  ],16  "propertyType": "STRING",17  "displayOrder": 1,18  "multiValued": false,19  "options": [20    {21      "optionName": "option_piano",22      "displayName": "Piano"23    },24    {25      "optionName": "option_cooking",26      "displayName": "Cooking"27    }28  ],29  "mandatory": false,30  "readAccessType": "ALL",31  "writeAccessType": "ADMIN_AND_SELF"32}

HTTP 400

Bad Request

HTTP 404

Not Found