ユーザー更新

PATCH

/linked_users/{linked_user_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/linked_users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"lastName":"すまれじ","firstName":"花子","email":"hanako@example.com","department":"総務部"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/linked_users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lastName": "すまれじ", "firstName": "花子", "email": "hanako@example.com", "department": "総務部" }'

ユーザー情報を更新します。

リクエストボディで指定されなかったフィールドは更新されません。

Authorizations

AppAccessToken
ec-b2b.linked-users:write

Parameters

Path Parameters

linked_user_id

required

string format: uuid

ユーザーID

Request Body^required

application/json

LinkedUserWritable

object

customerId

取引先ID

string format: uuid

statusCode

ステータス

1: 無効
2: 仮登録
3: 有効

integer

Allowed values: 1 2 3

department

部署名

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 255 characters

lastName

名前(姓)

string

>= 1 characters <= 50 characters

firstName

名前(名)

string

>= 1 characters <= 50 characters

lastNameFurigana

名前フリガナ(姓)

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 50 characters

firstNameFurigana

名前フリガナ(名)

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 50 characters

email

メールアドレス

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string format: email

nullable <= 255 characters

loginIdentification

ログインID

使用可能文字: 半角英数字および @ # . _ + -

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 255 characters

invitationAt

招待日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

registrationAt

会員登録日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

canEmailMagazineReceipt

メルマガ受信

0: 受け取らない
1: 受け取る

integer

Allowed values: 0 1

canDmReceipt

DM受信

0: 受け取らない
1: 受け取る

integer

Allowed values: 0 1

isLineLink

LINE ID連携

0: 未連携
1: 連携済

integer

Allowed values: 0 1

permissionCode

権限

1: 一般ユーザー
2: 管理者

integer

Allowed values: 1 2

password

パスワード

8文字以上72文字以下
大文字・小文字のアルファベットを含む
数字を含む
記号を含む

string format: password

>= 8 characters <= 72 characters

Examples

default

{
  "lastName": "すまれじ",
  "firstName": "花子",
  "email": "hanako@example.com",
  "department": "総務部"
}

Responses

200

更新成功

application/json

LinkedUserResponse

object

ユーザーID

string format: uuid

customerId

取引先ID

string format: uuid

statusCode

ステータス

1: 無効
2: 仮登録
3: 有効

integer

Allowed values: 1 2 3

department

部署名

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 255 characters

lastName

名前(姓)

string

>= 1 characters <= 50 characters

firstName

名前(名)

string

>= 1 characters <= 50 characters

lastNameFurigana

名前フリガナ(姓)

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 50 characters

firstNameFurigana

名前フリガナ(名)

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 50 characters

email

メールアドレス

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string format: email

nullable <= 255 characters

loginIdentification

ログインID

使用可能文字: 半角英数字および @ # . _ + -

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 255 characters

invitationAt

招待日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

registrationAt

会員登録日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

canEmailMagazineReceipt

メルマガ受信

0: 受け取らない
1: 受け取る

integer

Allowed values: 0 1

canDmReceipt

DM受信

0: 受け取らない
1: 受け取る

integer

Allowed values: 0 1

isLineLink

LINE ID連携

0: 未連携
1: 連携済

integer

Allowed values: 0 1

permissionCode

権限

1: 一般ユーザー
2: 管理者

integer

Allowed values: 1 2

lastLoginAt

最終ログイン日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

updatedAt

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Examples

default

{
  "id": "aaaaaaaa-1234-1234-1234-1234567890ab",
  "customerId": "12345678-1234-1234-1234-1234567890ab",
  "statusCode": 3,
  "department": "営業部",
  "lastName": "すまれじ",
  "firstName": "太郎",
  "lastNameFurigana": "スマレジ",
  "firstNameFurigana": "タロウ",
  "email": "sample@example.com",
  "loginIdentification": "taro_smaregi",
  "invitationAt": "2025-06-02T03:03:33+09:00",
  "registrationAt": "2025-06-02T03:03:33+09:00",
  "canEmailMagazineReceipt": 1,
  "canDmReceipt": 1,
  "isLineLink": 0,
  "permissionCode": 1,
  "lastLoginAt": "2025-06-09T14:15:40+09:00",
  "updatedAt": "2025-06-09T14:15:40+09:00"
}

400

入力チェックエラーの場合
パスワードの形式が不正な場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[lastName]は50文字以下で指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[password]は有効なパスワードを指定してください。",
  "status": 400
}

404

指定されたIDのリソースが見つからない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Example

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}

409

指定されたメールアドレスが既に登録されている場合
指定されたログインIDが既に登録されている場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "request_json:[email]はこの項目の値は既に存在しています。違う値を指定してください。",
  "status": 409
}

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "request_json:[loginIdentification]はこの項目の値は既に存在しています。違う値を指定してください。",
  "status": 409
}

ユーザー更新

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examples

Responses

200

Examples

400

Examples

404

Example

409

Examples

Request Body^required