PATCH/users/{userId}/user-profile-statuses/{userProfileStatusId}

ユーザーのステータスを部分更新する。

Authorization

oauth2

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

Scope

user
directory

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/users/{userId}/user-profile-statuses/{userProfileStatusId}

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 
userProfileStatusId string 

ユーザーステータス ID


required
example : uprofile-b785-4aae-c330-01e94337846b 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
profileStatusId string 

ステータス ID

  • BUSY : 取り込み中
  • AWAY : 離席中
  • LEAVE_OFFICE : 時間外
  • ABSENCE : 不在
  • CUSTOM01 ~ CUSTOM12 : カスタムステータス

Allowed values : BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01, CUSTOM02, CUSTOM03, CUSTOM04, CUSTOM05, CUSTOM06, CUSTOM07, CUSTOM08, CUSTOM09, CUSTOM10, CUSTOM11, CUSTOM12 
statusMessage string 

ステータスメッセージ


maxLength : 50
nullable : true 
startTime string 

開始日時 (形式: YYYY-MM-DDThh:mm:ssTZD)
startTime 値がある場合、endTime は必須。


format : date-time
nullable : true 
endTime string 

終了日時 (形式: YYYY-MM-DDThh:mm:ssTZD)
startTime 値がある場合、endTime は必須。


format : date-time
nullable : true 
autoReplyMail object (autoReplyMail) 

メールの自動応答


nullable : true 

autoReplyMail

PropertyTypeDescription
internal object (internal) 

社内メールの自動応答

 
external object (external) 

外部メールの自動応答

 

internal

PropertyTypeDescription
content string 

内容


maxLength : 300 
sentDirectlyToMe boolean 

メールの宛先 (To) に自分が含まれる場合のみ返信するためのフラグ


default : false 

external

PropertyTypeDescription
content string 

内容


maxLength : 300 
sentDirectlyToMe boolean 

メールの宛先 (To) に自分が含まれる場合のみ返信するためのフラグ


default : false 

Request Example

example

1{2  "profileStatusId": "BUSY",3  "statusMessage": "status message1",4  "startTime": "2017-03-16T09:00:00+09:00",5  "endTime": "2017-03-18T18:00:00+09:00",6  "autoReplyMail": {7    "internal": {8      "content": "internal mail content",9      "sentDirectlyToMe": true10    },11    "external": {12      "content": "external mail content",13      "sentDirectlyToMe": false14    }15  }16}

Response

HTTP 200

OK

PropertyTypeDescription
userProfileStatusId string 

ユーザーステータス ID

 
profileStatusId string 

ステータス ID

  • BUSY : 取り込み中
  • AWAY : 離席中
  • LEAVE_OFFICE : 時間外
  • ABSENCE : 不在
  • CUSTOM01 ~ CUSTOM12 : カスタムステータス

Allowed values : BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01, CUSTOM02, CUSTOM03, CUSTOM04, CUSTOM05, CUSTOM06, CUSTOM07, CUSTOM08, CUSTOM09, CUSTOM10, CUSTOM11, CUSTOM12 
profileStatusName string 

ステータス名

 
iconUrl string 

アイコン URL

 
scheduleType string 

現在ステータスまたは予約ステータス

  • PRESENT : 現在のステータス
  • RESERVED : 予約ステータス

Allowed values : PRESENT, RESERVED 
statusMessage string 

ステータスメッセージ


maxLength : 50
nullable : true 
startTime string 

開始日時 (形式: YYYY-MM-DDThh:mm:ssTZD)
startTime 値がある場合、endTime は必須。


format : date-time
nullable : true 
endTime string 

終了日時 (形式: YYYY-MM-DDThh:mm:ssTZD)
startTime 値がある場合、endTime は必須。


format : date-time
nullable : true 
autoReplyMail object (autoReplyMail) 

メールの自動応答


nullable : true 

autoReplyMail

PropertyTypeDescription
internal object (internal) 

社内メールの自動応答

 
external object (external) 

外部メールの自動応答

 

internal

PropertyTypeDescription
content string 

内容


maxLength : 300 
sentDirectlyToMe boolean 

メールの宛先 (To) に自分が含まれる場合のみ返信するためのフラグ

 

external

PropertyTypeDescription
content string 

内容


maxLength : 300 
sentDirectlyToMe boolean 

メールの宛先 (To) に自分が含まれる場合のみ返信するためのフラグ

 

Response Example

example

1{2  "userProfileStatusId": "uprofile-b785-4aae-c330-01e94337846b",3  "profileStatusId": "BUSY",4  "profileStatusName": "Busy",5  "iconUrl": "https://static.worksmobile.net/static/wm/settings/profile_state/ic-16-busy.png",6  "scheduleType": "PRESENT",7  "statusMessage": "status message1",8  "startTime": "2017-03-16T09:00:00+09:00",9  "endTime": "2017-03-18T18:00:00+09:00",10  "autoReplyMail": {11    "internal": {12      "content": "internal mail content",13      "sentDirectlyToMe": true14    },15    "external": {16      "content": "external mail content",17      "sentDirectlyToMe": false18    }19  }20}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found