顧客/取引先の連絡先の追加

    テナント内の特定ドメインに顧客/取引先の連絡先を追加します。
    連絡先は最大 5 万件まで追加できます。
    連絡先の電話番号、メールアドレスのいずれか 1 つは必須です。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/contact/v3/domains/{domainId}/shared/contacts

    HTTP Method

    POST

    Path Parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID

    Request Body

    パラメーター タイプ 上限 必須 説明
    open Boolean Y 公開範囲
    ● true: すべてのメンバー
    ● false: メンバー指定
    isCoEditing Boolean N 共同編集可否
    ● true: 共有メンバーによる編集可能 (既定)
    ● false: 管理者ユーザーのみ編集可能
    masterUserId String N 連絡先の管理者ユーザー ID
    sharedMembers[] List 500件 N 共有メンバーリスト。メンバー数は最大 500 人。公開範囲が false の場合は必須。
    sharedMembers[].id String Y ライトプランの場合の場合は、共有するメンバー ID、組織の ID。(localpart@group 形式)
    ベーシック/プレミアムプランの場合、メンバーのメールアドレス、組織またはグループのメーリングリスト。(localpart@domain 形式)
    ● 組織 ID を指定すると、該当する組織の直属メンバーだけに連絡先が共有され、下位組織のメンバーには共有されません。
    ● グループ ID を指定すると、該当のグループで同じドメインのメンバーだけに連絡先が共有され、グループ ID ではなく、共有されたメンバーの ID が保存されます。
    sharedMembers[].type String Y sharedMembers[].id のタイプ
    ● USER: メンバー
    ● ORGUNIT: 組織
    ● GROUP: グループ
    tagResourceIds[] List<String> N タグのリソース ID リスト
    name Object Y 名前情報
    name.lastName String 100字 N 姓 (姓もしくは名のいずれか 1 つは必須)
    name.firstName String 100字 N 名 (姓もしくは名のいずれか 1 つは必須)
    name.phoneticLastName String 100字 N 姓 (フリガナ)
    name.phoneticFirstName String 100字 N 名 (フリガナ)
    name.prefix String 100字 N 敬称 (Honor)
    name.suffix String 100字 N 呼称 (Suffix)
    name.middleName String 100字 N ミドルネーム (Middle)
    name.nickName String 100字 N ニックネーム
    emails[] List 100件 N メールリスト
    emails[].address String 256字 Y メールアドレス。
    標準メール形式のみ入力可。
    emails[].represent Boolean Y 代表メールアドレスフラグ
    phones[] List 100件 N 電話番号リスト
    phones[].value String 100字 Y 電話番号
    1字以上の数字と - * # + P T ( )のみ入力可。
    phones[].type String Y 電話番号タイプ
    ● MOBILE: 携帯
    ● WORK: 勤務先
    ● HOME: 自宅
    ● WORK_FAX: 勤務先のFAX
    ● HOME_FAX: 自宅のFAX
    ● OTHER: その他
    ● CUSTOM: 直接入力
    これ以外の値は CUSTOM で設定されます。
    phones[].customType String 100字 N 直接入力 (CUSTOM) した電話番号タイプ。
    電話番号タイプが CUSTOM の場合のみ入力可。
    phones[].represent Boolean Y 代表電話番号フラグ
    organizations[] List 100件 N 会社の所属リスト
    organizations[].name String 100字 Y 会社名
    organizations[].department String 100字 Y 部署名
    organizations[].title String 100字 Y 役職名
    organizations[].represent Boolean Y 代表会社フラグ
    locations[] List 100件 N 住所リスト
    locations[].value String 100字 Y 住所
    locations[].zipcode String 100字 Y 郵便番号
    locations[].type String Y 住所タイプ
    ● WORK: 勤務先
    ● HOME: 自宅
    ● OTHER: その他
    ● CUSTOM: 直接入力
    これ以外の値は CUSTOM で設定されます。
    locations[].customType String 100字 N 直接入力 (CUSTOM) した住所タイプ。
    住所タイプが CUSTOM の場合のみ入力可。
    locations[].represent Boolean Y 代表住所フラグ
    events[] List 100件 N イベント (誕生日・記念日) リスト
    events[].value String 100字 Y 日付 (yyyyMMdd)
    events[].dayType String Y 日付形式
    ● S: 西暦
    ● L: 旧暦
    これ以外の値は S で設定されます。
    events[].type String Y イベントタイプ
    ● BIRTHDAY: 誕生日
    ● ANNIVERSARY: 記念日
    ● OTHER: その他
    ● CUSTOM: 直接入力
    これ以外の値は CUSTOM で設定されます。
    events[].customType String 100字 N 直接入力 (CUSTOM) したイベントタイプ。
    イベントタイプが CUSTOM の場合のみ入力可。
    events[].represent Boolean Y 代表イベントフラグ
    messengers[] List 100件 N SNS リスト
    messengers[].id String 100字 Y SNS ID
    messengers[].type String Y SNS タイプ
    ● LINE
    ● FACEBOOK
    ● TWITTER
    ● CUSTOM: 直接入力
    これ以外の値は CUSTOM で設定されます。
    messengers[].customType String 100字 N 直接入力 (CUSTOM) した SNS タイプ。
    SNS のタイプが CUSTOM の場合のみ入力可。
    messengers[].represent Boolean Y 代表 SNS フラグ
    websites[] List 100件 N Web サイトリスト
    websites[].value String 100字 Y Web サイト URL
    websites[].represent Boolean Y 代表 Web サイトフラグ
    photos[] List 6件 N 写真リスト
    1 番目の写真がプロフィール写真に指定されます。
    photos[].path String Y アップロードされた写真のパス。
    顧客/取引先の連絡先写真のアップロードAPI参照。
    photos[].represent Boolean Y 代表写真フラグ
    memo String 4000字 N メモ

    Request Example

    POST https://apis.worksmobile.com/r/apiid/contact/v3/domains/123/shared/contacts
    
    {
       "open":false,
       "isCoEditing": true,
       "masterUserId": "account1@example.com",
       "sharedMembers":[
          {
             "id":"account1@example.com",
             "type":"USER"
          },
          {
             "id":"account2@example.com",
             "type":"USER"
          },
          {
             "id":"orgunit1@example.com",
             "type":"ORGUNIT"
          },
          {
             "id":"dl_email@example.com",
             "type":"GROUP"
          }
       ],
       "tagResourceIds":[
          "efse4567-e89b-12d3-a456-426614174000",
          "774117c8-7a68-4c67-62a8-0312dd90b9b3"
       ],
       "name":{
          "firstName":"First Name",
          "lastName":"Last Name",
          "nickName":"Nick Name"
       },
       "emails":[
          {
             "address":"example@email.com",
             "represent":true
          }
       ],
       "phones":[
          {
             "value":"0000-0001",
             "type":"WORK",
             "represent":true
          },
          {
             "value":"0000-0002",
             "type":"CUSTOM",
             "customType":"Custom Type",
             "represent":false
          }
       ],
       "organizations":[
          {
             "name":"Organization",
             "department":"Department",
             "title":"Job Title",
             "represent":true
          }
       ],
       "locations":[
          {
             "value":"Home Address",
             "zipcode":"000-111",
             "type":"HOME",
             "represent":true
          },
          {
             "value":"Custom Address",
             "zipcode":"000-111",
             "type":"CUSTOM",
             "customType":"Custom type",
             "represent":false
          }
       ],
       "events":[
          {
             "value":"20170313",
             "dayType":"S",
             "type":"BIRTHDAY",
             "represent":true
          }
       ],
       "messengers":[
          {
             "id":"lineid",
             "type":"LINE",
             "represent":true
          },
          {
             "id":"customid",
             "type":"CUSTOM",
             "customType":"customlabel",
             "represent":false
          }
       ],
       "websites":[
          {
             "value":"homepage.com",
             "represent":true
          }
       ],
       "photos":[
          {
             "path":"/upload/photo/1234.jpg",
             "represent":true
          }
       ],
       "memo":"Memo content"
    }
    

    Response

    呼び出しに成功すると HTTP 200 コードと次の値を返します。

    プロパティ タイプ 説明
    resourceId String 追加した連絡先のリソース ID
    Response Example
    {
        "resourceId": "550e8400-e29b-41d4-a716-446655440000"
    }
    

    Error Code

    API の呼び出しに失敗すると、エラーコードとエラーメッセージを返します。
    詳細はアドレス帳APIのエラーコードを参照してください。