Partially Edit Members

    Edits part of member information. Note that you cannot change Admin to Sub Admin or Member by using this API.

    Note

    • You can use Delegate Admin from Member > Manage Admin/Authority in the LINE WORKS Admin system to change the Admin. After the authority is delegated to another person and that person approves it, the previous Admin becomes a Member.
    • For the Basic/Premium products, when a member's email address is changed, use the "Edit Member Email Addresses" API to automatically register the member's previous email address as a sub email address. The "Partially Edit Members" API edits a member's sub email address, based on the aliasEmails parameter.
    • External Messaging and member emails
      • If a member’s email that is used as an External Messaging ID is modified, the External Messaging ID is also updated.
      • If the new email contains prohibited keywords (NG WORD), add the previous email as a sub email address (sub ID for the Lite product) so that it can still be used as the External Messaging ID.
      • For the Basic/Premium products, it is required to pass the sub email address for External Messaging using the "aliasEmails" parameter.

    Caution

    • The previous data remains the same if the parameter is null, or is all deleted if the parameter is empty (such as "" in String or [] in List).
    • Example 1) Where the previous value of the subEmail parameter is "aa@example.com,"
           - If the parameter is null, "aa@example.com" remains the same.
           - If the parameter is empty, "" is saved, which means that the previous data is deleted.
           - If the parameter is set to "cc@example.com," the previous data is changed to "cc@example.com."
    • Example 2) Where the previous value of the aliasEmails parameter is ["aa@example.com", "bb@example.com"],
           - If the parameter is null, ["aa@example.com", "bb@example.com"] remains the same.
           - If the parameter is empty, [] is saved, which means that the previous data is deleted.
           - If the parameter is set to ["cc@example.com"], the previous data is changed to ["cc@example.com"].

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}

    HTTP Method

    PATCH (Content-Type: application/json; charset=UTF-8)

    Path Parameters

    Parameter Type Length Required Description
    domainId Integer Y The primary position's domain ID
    externalKey String 100 characters Y An external key for members in the primary position
    For a group of companies, it must be unique in the group.
    Special characters, \%#/? are not allowed.

    Request Body

    Parameter Type Length Required Description
    email String 90 characters N Account.
    Member's email address for the Basic and Premium products.
    id@group for the Lite product.
    ● localpart@domain (localpart@group for the Lite product)
    ● A localpart must start with a lowercase English letter or a number.
    ● A dot (.) cannot be the first or last character of a localpart, and two or more consecutive dots are not allowed.
    ● A localpart must be between 2 and 40 characters, and can contain lowercase English letters, numbers, dot (.), hyphen (-), and underscore (_) only.
    name Object N Name
    name.lastName String N Family name.
    The full name can be up to 80 characters long.
    Either lastName or firstName must be specified.
    The following special characters are allowed only: ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~
    name.firstName String N Given name.
    The full name can be up to 80 characters long.
    Either lastName or firstName must be specified.
    The following special characters are allowed only: ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~
    name.phoneticLastName String 100 characters N Family name in Furigana.
    (Katakana only)
    name.phoneticFirstName String 100 characters N Given name in Furigana.
    (Katakana only)
    i18nNames[] List N Names by language code
    i18nNames[].language String N Language code.
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nNames[].firstName String 100 characters N Given name in the language.
    A family name is followed by a given name on the organization chart.
    The following special characters are allowed only: ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~
    i18nNames[].lastName String 100 characters N Family name in the language.
    A family name is followed by a given name on the organization chart.
    The following special characters are allowed only: ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~
    nickName String 100 characters N Nickname.
    The following special characters are allowed only: ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~
    privateEmail String 256 characters N Personal email address.
    Required when SSO is not used.
    Required if the member is the Admin.
    The email address must be valid.
    aliasEmails List<String> 10 N Sub email addresses.
    Available only for the Basic/Premium products.
    ● Each email address can be up to 90 characters long.
    ● localpart@domain
    ● A localpart must start with a lowercase English letter or a number.
    ● A dot (.) cannot be the first or last character of a localpart, and two or more consecutive dots are not allowed.
    ● A localpart must be between 2 and 40 characters, and can contain lowercase English letters, numbers, dot (.), hyphen (-), and underscore (_) only.
    employmentTypeExternalKey String 100 characters N External key for employment types.
    It is available only if "useEmploymentType" of the "Enable Employment Types" API is "true." If this parameter is omitted, no employment type applies.
    searchable Boolean N Indicates whether to enable auto-complete and search for members.
    Default: true
    organizations[] List N List of domains (companies) to which the member belongs (including both the primary and secondary positions)
    organizations[].domainId Integer Y Domain ID.
    ● Required if organizations[] is specified.
    ● Primary/secondary positions: A member has only one position if organizations[].domainId is the same as the domainId in Path Parameter, and has the secondary position if not.
    organizations[].externalKey String 100 characters N An externalKey for members.
    ● If not specified, it is set to the externalKey in Path Parameter.
    ● For a group of companies, it must be unique in the group.
    ● Special characters, \%#/? are not allowed.
    organizations[].email String 90 characters N Email address.
    Use this parameter if a member needs two different email addresses for the primary and secondary positions while using the Basic/Premium products.
    ● localpart@domain
    ● A localpart must start with a lowercase English letter or a number.
    ● A dot (.) cannot be the first or last character of a localpart, and two or more consecutive dots are not allowed.
    ● A localpart must be between 2 and 40 characters, and can contain lowercase English letters, numbers, dot (.), hyphen (-), and underscore (_) only.
    organizations[].levelExternalKey String 100 characters N An external key for levels.
    It is available only if "useLevel" of the "Enable Levels" API is "true." If this parameter is omitted, no level applies.
    organizations[].orgUnits[] List 20 N Organizations
    organizations[].orgUnits[].externalKey String 100 characters Y An external key for organizations
    organizations[].orgUnits[].represent Boolean N Indicates whether or not it is the default organization.
    ● If this parameter is not specified, the first one of organizations[].orgUnits[] becomes the default organization.
    ● If you need to set a company as the default or secondary organization, set this parameter to "true" for the default organization, or "false" for the secondary organization.
    organizations[].orgUnits[].positionExternalKey String 100 characters N An external key for positions.
    It is available only if "usePosition" of the "Enable Positions" API is "true." If this parameter is omitted, no position applies.
    organizations[].orgUnits[].manager Boolean N Indicates whether the member is a manager or not.
    If it is true, the member becomes the manager and the previous manager, if there is, is relieved of his or her duties.
    ● Default: false
    organizations[].orgUnits[].display Boolean N Indicates whether to show the member.
    ● It indicates whether to show the member on the organization chart.
    ● Default: true
    organizations[].orgUnits[].receiveEmail Boolean N Indicates whether to enable team features.
    ● Default: true
    ● Use this parameter when you need to limit the following team features of a member for security purposes: receiving messages in the team room, sharing files and receiving organization emails.
    ● If this parameter is true, the following team features are enabled.
    - As a member of the team room (Message/Note/Calendar/Folder), the member can send/receive messages, view notes, receive shared calendar events and view folders.
    - The member can receive email messages sent to the organization.
    - The member can receive calendar events shared to the organization.
    - The member can view the organization calendar.
    - The member can view files in the drive shared to the organization.
    - The member can view boards with the permissions given to the organization.
    - The member can respond to surveys of the organization.
    - The member also becomes a member of the group which the organization belongs to.
    ● If this parameter is false, all the team features described above are disabled. Set this parameter to false if you do not allow the member to use the team features.
    telephone String 100 characters N Telephone number.
    Only numbers with the following characters are allowed: - * # + P T ( )
    cellphone String 100 characters N Mobile phone number.
    Only numbers with the following characters are allowed: - * # + P T ( )
    fax String 100 characters N Fax number.
    Only numbers with the following characters are allowed: - * # + P T ( )
    location String 100 characters N Office location
    task String 100 characters N Task
    messenger Object N
    messenger.protocol String 8 characters N Messenger protocol.
    ● LINE: LINE
    ● FACEBOOK: Facebook
    ● TWITTER: Twitter
    ● CUSTOM: Custom protocol
    messenger.customProtocol String 100 characters N Custom protocol if the messenger protocol is "CUSTOM"
    messenger.messengerId String 100 characters N Messenger ID
    birthdayCalendarType String 1 character N Birthday type.
    ● S: Solar calendar
    ● L: Lunar calendar
    birthday String 10 characters N Date of birth (yyyy.mm.dd)
    hireDate String 10 characters N Date of hire (yyyy.mm.dd)
    locale String N Refer to Language Codes.
    timeZone String N Refer to Timezone Codes v2.
    customField Object N Custom field
    A schema must be added first with the “Add Custom Field Schemas” API.
    customField.{schemaKey}[] List 10 Y Custom field schema key defined in the primary position’s domain.
    This key is the key of the map.
    Up to 10 external keys are allowed.
    customField.{schemaKey}[].value String 100 characters N Custom field’s text to display
    customField.{schemaKey}[].link String 300 characters N URL if the type of custom field is link
    - A value or link must be specified.
    - If both of them are specified where the value is "Homepage1" and the link is "https://www.unicef.org":
    <a href = "https://www.unicef.org">Homepage1</a>
    - If only a value is specified, a hyperlink is not created.
    - If only a link is specified, it is displayed as text.

    Request Example

    PATCH https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123
    
    {
      "name": {
        "lastName": "Jones",
        "firstName": "David",
        "phoneticLastName": "",
        "phoneticFirstName": ""
      }
    }
    

    Response

    It returns HTTP status 200 with no response when the API call is successful.

    Error Code

    It returns an error code and message when the API call fails.
    Refer to Organization Integration REST API Error Codes for details.